Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

checklist-completion.tsx #354

Closed
wants to merge 10 commits into from
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<br>

### Table of Contents

1. [Introduction](#introduction)
- [What is Animata?](#what-is-animata)
- [What is not Animata?](#what-is-not-animata)
Expand All @@ -49,24 +50,29 @@
3. [Contributing](#contributing)
4. [Authors](#authors)
5. [License](#license)

## Introduction

### What is Animata?

Welcome to Animata, a free and open-source collection of hand-crafted animations, effects, and interactions that you can seamlessly integrate into your project with a simple copy and paste. The animations are built using TailwindCSS and React.js, so they can be easily customized to fit your project's design.

### What is not Animata?

Animata is not a full-fledged UI library like Material-UI or Chakra-UI. It is a collection of animations and effects that you can use to enhance your project's design. You can also use Animata alongside other UI libraries or design systems (you will need to set up TailwindCSS for this).

## Getting Started

You don't need to install it as a dependency instead you can simply copy and paste the code, as shadcn/ui, into your project. However, you still need to install the other dependency that the code needs.

### Requirements

- [TailwindCSS](https://tailwindcss.com/docs/installation): For styling.
- [Framer Motion](https://www.framer.com/motion/) (Optional): For complex animations.
- [Lucide Icons](https://lucide.dev/) or [Radix Icons](https://www.radix-ui.com/icons) (Optional): Use for icons, or replace with any other icon library or SVGs.

### Setup Instructions

#### Folder Structure (Recommended)

```bash
Expand All @@ -87,7 +93,9 @@ where `/` is the root of your project, `/components` is where you keep your comp
}
}
```

#### Install Dependencies

Install the required dependencies, if you haven't already:

```sh
Expand All @@ -103,18 +111,20 @@ module.exports = {
```

### Create Utility Functions

Create utils.ts file in the libs folder and paste the following code:

```ts
import { type ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";

export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
```

#### NOTE

1. If you see something that has been imported but not mentioned in the documentation, then it is a dependency you need to install. If it starts with @/ then it is Animata's component else it is an external dependency. In such a case, you can submit a PR to update the documentation.
2. If something is not working, the docs probably miss the tailwind.config.js updates. You can look for the entries that have been added to the tailwind.config.js in Animata's source code. You can create an issue or submit a PR to update the documentation.

Expand All @@ -127,6 +137,7 @@ Contributions to Animata are always welcome!
or find us on [Discord](https://discord.gg/STYEh3UW), we will take the time to guide you.

## Authors

Heartfelt gratitude goes to each of you for your amazing contributions to this project. Your hard work, creativity, and dedication have been nothing short of incredible. Whether it was coding, debugging, testing, or sharing ideas, every effort made a significant difference.

<section id="#Authors"
Expand Down
88 changes: 0 additions & 88 deletions animata/container/animated-dock.stories.tsx

This file was deleted.

186 changes: 0 additions & 186 deletions animata/container/animated-dock.tsx

This file was deleted.

19 changes: 19 additions & 0 deletions animata/progress/checklist-completion.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import ChecklistCompletion from "@/animata/progress/checklist-completion";
import { Meta, StoryObj } from "@storybook/react";

const meta = {
title: "Progress/Checklist Completion",
component: ChecklistCompletion,
parameters: {
layout: "centered",
},
tags: ["autodocs"],
argTypes: {},
} satisfies Meta<typeof ChecklistCompletion>;

export default meta;
type Story = StoryObj<typeof meta>;

export const Primary: Story = {
args: {},
};
Loading
Loading