guokaigdg/animal-island-vue

Animal-Island-Vue is a small UI component library for the Vue 3 web framework. The visual style is inspired by the look of the Nintendo game Animal Crossing New Horizons, with rounded shapes, soft colours, and playful icons. The author built it for personal practice and learning, and it is a Vue port of an earlier React version called animal-island-ui by the same person. The README is careful to point out that this is not an official Nintendo product. The game name is mentioned only as a description of the visual style, not as a brand. All the icons, layouts, and animations were drawn from scratch by the author, and no Nintendo artwork or code is included. The library is licensed under MIT, but the author asks that it only be used for learning, research, and personal projects, not in commercial products or paid templates. The library is published to npm under the name animal-island-vue. You install it with npm install animal-island-vue and then import the components you want from the package. The README warns that you also have to import the stylesheet, with the line import 'animal-island-vue/style', or the components will appear without any of their styles or custom fonts. A short example shows how to use the Button, Card, and Modal components inside a single file Vue component using the script setup syntax with TypeScript. The project is built with Vue 3, TypeScript, and Less. There are online demos for both desktop and mobile layouts, hosted on GitHub Pages. The README links to a few related projects that already use the library, including a personal site template called ac-site-template, a children's English learning app called HiKid, and an Animal Crossing themed blog called animal-island-blog. There is also a separate AI_USAGE.md document that lists every component, every prop, every type, and every default value, intended to be fed to AI coding assistants so they do not invent APIs that do not exist. For local development the README gives the usual flow: clone the repo, run npm install, then npm run dev to start the demo dev server, npm run build to build the component library, and npm run build:docs to build the demo site. A CHANGELOG and a CONTRIBUTING guide are also included.