Skip to content

guokaigdg/animal-island-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

113 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🏝 Animal-Island-UI

animal-island-ui
A React UI component library inspired by Animal Crossing: New Horizons

Stars License Version Stars
Coverage Tests Components Accessibility

Featured|HelloGitHub

English | 简体中文

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

Preview

🚀 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


animal-island-new-tab
Animal Island New Tab
Animal Crossing style new tab page

ac-site-template
ac-site-template
Animal Crossing themed personal website template

HiKid
HiKid
English learning app for children

android-ui
AnimalIslandUI
Animal Crossing style Android UI library

ItbugShop
ItbugShop
Liang Diandian's Blog

KidsMathQuest
KidsMathQuest
Math practice for elementary school

animal_island_flutter
animal_island_flutter
Animal Crossing style Flutter UI library

animal-island-blog
animal-island-blog
Animal Crossing style blog

island-life-journal
Island Life Journal
Island Life Photo Journal

Animal-Crossing-BGM-Player
Animal Crossing BGM Player
ambience clock + hourly music

Notes

  • This project is for personal learning, research, and non-commercial demonstration only. Any form of commercial use, resale, or profit-making activities is prohibited.
  • Not for use in any commercial products, enterprise projects, external services, or paid templates.
  • 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

MIT This project is released under the MIT open-source license, for learning use only. The author is not responsible for any legal issues or losses caused by the use of this library.

About

Animal 风格的 React 组件库 灵感来源于任天堂《集合啦!动物森友会》 Vue 版同步发布 Animal Crossing-style React UI component library, inspired by Nintendo's game visuals Vue version available.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors