🏝 Animal-Island-UI

Introduction

This project is a lightweight UI component library built with React + TypeScript. The design style is inspired by Nintendo's "Animal Crossing: New Horizons" game interface, created for personal front-end technical practice and component development learning.

All visual elements, layouts, icons, and animations are independently designed and implemented, without directly using any official Nintendo art materials, code, or resource files.

🎉 Vue Version

• animal-island-vue

Preview

• Online Preview (PC) animal-island-ui-pc
• Online Preview (Mobile) animal-island-ui-mobile

🚀 Use AI to Generate animal-island-ui Pages (No Coding Needed)

Non-developer and don't want to write code yourself? Use PROMPT.md — no npm, no build step.

4 steps:

1. Copy PROMPT.md in full.
2. Paste into any AI tool (Cursor / Claude / ChatGPT / Gemini / DeepSeek) and send.
3. The AI asks what page you want — reply in one phrase (e.g. "personal blog", "product list", "FAQ").
4. Save the index.html it returns and double-click to preview.

Installation

npm install animal-island-ui

Quick Start

⚠️ Important: Please make sure to import the styles with import 'animal-island-ui/style', otherwise the components will have no styles or fonts!

import { Button, Card } from 'animal-island-ui';
import 'animal-island-ui/style';

function App() {
    return (
        <div>
            <Button type="primary">Start Adventure</Button>
            <Card color="app-blue">Welcome to the deserted island!</Card>
        </div>
    );
}

Documentation

Complete reference for different scenarios:

| Document | Purpose | | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | PROMPT.md | 🚀 One-click prompt for non-developers — paste into Cursor / Claude / ChatGPT / v0 / Bolt / Lovable / Windsurf to generate animal-island-ui-styled React pages. | | AI_USAGE.md | AI code assistant handbook - all component props, types and defaults word-for-word, 19 hard rules and copy-paste boilerplate, no invented APIs. | | DESIGN_PROMPT.md | Visual-style prompts for v0 / Figma AI / Midjourney / DALL-E, including color palette, fonts, size tables, Modal clip-path and prohibition list. | | skill/SKILL.md | Pixel-perfect style specification Skill - design tokens, all component CSS, Demo layout values, CSS variable templates and new component development checklist. | | CONTRIBUTING.md | Contributing Guide |

Local Development

# Clone the repository
git clone https://github.com/guokaigdg/animal-island-ui.git
cd animal-island-ui

# Install dependencies
npm install

# Start Demo development server
npm run dev

# Build component library
npm run build

# Build Demo site
npm run build:demo

Usage Cases

Notes

• This project is intended for personal learning, research, and non-commercial demonstration only. Any form of commercial use, resale, or profit-making activities is prohibited.
• Not to be used in any commercial product, enterprise project, external service, or paid template.
• Users are solely responsible for any risks arising from the use of this component library.

Copyright and Disclaimer

• This project is not an official Nintendo product and has no association, authorization, or cooperation with Nintendo Co., Ltd.
• The game name included in the project name is only a descriptive reference to the style and does not constitute trademark use or brand association.
• All interface styles are merely design inspiration references and do not constitute reproduction or infringement of the original work.
• If the copyright holder believes that related content is suspected of infringement, they can contact via email, and I will make rectifications or deletions immediately.

Contact

For any questions or copyright-related communications, please contact via Issue or email.

License

Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) — see the LICENSE file for the full text.

• Commercial use: PROHIBITED.
• Permitted (non-commercial): personal learning, research, evaluation, testing, and non-commercial display.
• Attribution required: must retain the original copyright notice and license declaration.
• The author is not responsible for any legal issues or losses caused by the use of this library.