{"id":14962129,"url":"https://github.com/charlie85270/tail-kit","last_synced_at":"2025-04-13T22:28:28.136Z","repository":{"id":38307006,"uuid":"320413748","full_name":"Charlie85270/tail-kit","owner":"Charlie85270","description":"Tail-kit is a free and open source components and templates kit fully coded with Tailwind css 3.0. ","archived":false,"fork":false,"pushed_at":"2023-10-31T01:11:15.000Z","size":11558,"stargazers_count":2924,"open_issues_count":8,"forks_count":319,"subscribers_count":35,"default_branch":"main","last_synced_at":"2024-10-29T15:17:41.896Z","etag":null,"topics":["component-library","components","components-kit","kit","tailwind","tailwind-css","tailwind-kit","tailwindcss","tailwindui","template","templates","ui-components","uikit"],"latest_commit_sha":null,"homepage":"https://www.tailwind-kit.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Charlie85270.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Charlie85270","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-12-10T23:20:04.000Z","updated_at":"2024-10-28T17:24:18.000Z","dependencies_parsed_at":"2024-09-17T14:02:07.995Z","dependency_job_id":"e8a50d9a-84ff-45f2-963c-84d727e2da2e","html_url":"https://github.com/Charlie85270/tail-kit","commit_stats":{"total_commits":205,"total_committers":21,"mean_commits":9.761904761904763,"dds":0.2878048780487805,"last_synced_commit":"80efd91e8e40fd6b3e0f20fd0a00dd7614593fa9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Charlie85270%2Ftail-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Charlie85270%2Ftail-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Charlie85270%2Ftail-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Charlie85270%2Ftail-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Charlie85270","download_url":"https://codeload.github.com/Charlie85270/tail-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248790388,"owners_count":21162001,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component-library","components","components-kit","kit","tailwind","tailwind-css","tailwind-kit","tailwindcss","tailwindui","template","templates","ui-components","uikit"],"created_at":"2024-09-24T13:29:20.504Z","updated_at":"2025-04-13T22:28:28.095Z","avatar_url":"https://github.com/Charlie85270.png","language":"TypeScript","funding_links":["https://github.com/sponsors/Charlie85270"],"categories":[],"sub_categories":[],"readme":"# Tail-Kit\n\n![version](https://img.shields.io/badge/version-1.0.0-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) ![GitHub issues](https://img.shields.io/github/issues/Charlie85270/tail-kit) \u003ca href=\"https://www.tailwind-kit.com/\" target=\"_blank\"\u003e\n![GitHub Repo stars](https://img.shields.io/github/stars/Charlie85270/tail-kit?style=social)\n\n![Tailwind-Kit](https://www.tailwind-kit.com/home.png)\n\n\u003c/a\u003e\n\n### A beautiful and large components and templates kit for TailwindCSS 3.0\n\nTail-Kit is Free and Open Source. It does not change or add any CSS to the already one from TailwindCSS 3.0. It features multiple HTML elements that can be used in all web projects who's use tailwind CSS.\n\n## Components\n\nTailwind Starter Kit comes with 230+ Fully Coded CSS elements.\n\n## Templates\n\nTailwind Starter Kit contains many templates like dashboards, landing pages, login pages etc. All are fully Coded and ready to copy paste.\n\n![Tailwind-Kit](https://www.tailwind-kit.com/dashboard.png)\n\n![Tailwind-Kit](https://www.tailwind-kit.com/template.png)\n\n![Tailwind-Kit](https://www.tailwind-kit.com/template2.png)\n\nand much more !!\n\n## Live code editor\n\n![Tailwind-Kit](https://i.ibb.co/g3n4NMg/Capture-d-e-cran-2020-12-27-a-12-06-16.png)\n\nTailwind-kit include a live code editor to change the components code and see in live the modification.\n\n## Dark mode\n\n![Tailwind-Kit](https://www.tailwind-kit.com/demo.gif)\n\nMost components and templates are implemented with a light and dark version, with the new dark mode 3.0 feature of tailwind CSS.\n\n## Documentation\n\nThe documentation for the Tailwind-kit is hosted at our \u003ca href=\"https://www.tailwind-kit.com/started\" target=\"_blank\"\u003ewebsite\u003c/a\u003e.\n\n## Browser Support\n\nAt present, we officially aim to support the last two versions of the following browsers:\n\n|                                                               Chrome                                                                |                                                               Firefox                                                                |                                                               Edge                                                                |                                                               Safari                                                                |                                                               Opera                                                                |\n| :---------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------: |\n| \u003cimg src=\"https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/chrome-logo.png\" width=\"64\" height=\"64\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/firefox-logo.png\" width=\"64\" height=\"64\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/edge-logo.png\" width=\"64\" height=\"64\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/safari-logo.png\" width=\"64\" height=\"64\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/opera-logo.png\" width=\"64\" height=\"64\"\u003e |\n\n## Reporting Issues/ make Pull request\n\nEvery Issues, and PR are welcome !\nthe site is not perfect, there must be typos, bugs, improvements.\nDo not hesitate to contribe and add your own components/layout.\n\n## Getting Started\n\n![Tailwind-Kit](https://camo.githubusercontent.com/6202639220e8972265da4543eb10e428adbf579b8a07fc427bc90b383647a3c9/68747470733a2f2f7777772e6a6f616f706564726f2e63632f696d672f6769746875622f747970657363726970742d6e6578746a732d737461727465722e706e67)\n\nTail-Kit is a static site build with [Next.js](https://nextjs.org/) and typescript.\n\n### Prerequisites:\n\nNode.js 10.13 or later\n\nRecommanded : **Node v12.18.3**\n\nInstall dependencies:\n\n```bash\nnpm install\n# or\nyarn install\n```\n\nRun the development server:\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the result.\n\nYou can start editing the page by modifying `pages/_index.tsx`. The page auto-updates as you edit the file (static folder : /out).\n\nBuild the static site:\n\n```bash\nnpm run build\n# or\nyarn build\n```\n\n## 🧐 What's inside?\n\nA quick look at the important repo files and directories you'll see in a the project.\n\n    .\n    ├── node_modules\n    ├── public\n    ├── pages\n    ├── components\n    \t ├── kit\n            ├── components\n            ├── templates\n         ├── layout\n         ├── site\n    ├── utils\n    ├── editorTheme.tsx\n    ├── global.css\n    ├── LICENSE\n    ├── next.config.js\n    ├── tailwind.config.js\n    ├── package.json\n    ├── README\n    ├── tsconfig.json\n    ├── .gitignore\n    └── yarn.lock.json\n\n1.  **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.\n\n1.  **`/public`**: This directory contain all the public assets that need the project (images, icons).\n\n1.  **`/pages`**: This directory contain all pages of the app. See [NextJs pages documentation](https://nextjs.org/docs/basic-features/pages/) for more details\n\n1.  **`/components`**: This directory contain all components and templates of the app.\n\n    1.  **kit** : contains all components and templates used for demonstration/preview. Component/templates are sorted by section (Commerce, Elements, Forms ...). Each section have his directory.\n    1.  **layout** : contains all layout used in the application. See [NextJs layout documentation](https://nextjs.org/learn/basics/assets-metadata-css/layout-component) for more details\n    1.  **site** : contains all component used for the structure of the application (header, footer, home, ...)\n\n1.  **`/utils`**: This directory contain all utils classes, like html parser, html beautifier (use to indent the components code on preview)\n\n1.  **`editorTheme.tsx`**: This file is the configuration theme (colors) for the components code preview. See [react-prism](https://github.com/FormidableLabs/prism-react-renderer#theming) for more details\n\n1.  **`global.css`**: This css file contain all the 'custom' css use for the app (home page animation)\n\n1.  **`LICENSE`**: Bulma-css is licensed under [EULA](./LICENSE.md).\n\n1.  **`next.config.js`**: This file contain all the nextJS configuration. Here we use the default one.\n1.  **`tailwind.config.js`**: This file contain all the Tailwind configuration.\n\n1.  **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.\n\n1.  **`README.md`**: A text file containing useful reference information about your project.\n\n1.  **`tsconfig.json`**: The presence of a tsconfig.json file in a directory indicates that the directory is the root of a TypeScript project. The tsconfig.json file specifies the root files and the compiler options required to compile the project.\n\n1.  **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.\n\n1.  **`yarn-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**\n\n## 📋 Create a new section\n\nComponents and templates are sorted by category.\n\nCategories are sorted by section.\n\nA section can have one or more category.\n\nCategory can have one or more component/templates.\n\nTo add a new main section like **_Commerce, Element, Form_** .. you must :\n\n1.  Create your new directory in **components/kit/components/{yourSectionName}** or **components/kit/templates/{yourSectionName}**. It's inside this directory that you will put all your components/templates files.\n2.  Create a **index.tsx** file on this new directory. It will contain the description (categories names, components/tempaltes numbers, title, ....) of the section. See other section files for an example.\n3.  Each time you want create a new category on a section you will need create a directory in the directory of this one. Then you will put the component/templates file in the category directory.\n\nSee an example :\n\n    ├── components\n    \t ├── kit\n         \t├── components\n            \t├── MyNewSection // section directory\n                \tindex.tsx // section description file\n                \t├── MyCategory // category directory\n                    \t\tMyComponent.tsx // My component source file\n                            MyComponent2.tsx // My component source file\n                            ....\n            ├── templates\n         ├── layout\n         ├── site\n    ├── ...\n    └── ...\n\n## 📁 Create a new category\n\nAs seen just above, to create a new category you need to create a directory on a section that will contains your components. We also need to create the category page.\n\n1.  Create your new directory in **pages/components/{yourCategoryName}** or **pages/templates/{yourCategoryName}**. It's inside this directory that we will put the category page code.\n2.  Create a **index.tsx** file on this new directory. It will contain all the components/templates that we want import and see in this category. See other category files for an example.\n3.  When index.tsx is created NextJs create a route for this category that we can see on : http://localhost:3000/components/{yourCategoryName} or http://localhost:3000/templates/{yourCategoryName}\n\n## ➕ Create a new component/templates\n\nComponents and templates are classics React functional component.\n\n### dark/light mode\n\nIf you want that your component have a dark version, use Tailwind classes for dark mode [(documentation)](https://tailwindcss.com/docs/dark-mode).\n\n### Import the component\n\nThe last thing to do is to import your component/template on the wanted category file : **(/pages/components/{category}/index.tsx)** or **(/pages/templates/{category}/index.tsx)**\n\nTo enabled all feature preview like live edition, dark mode, ... you need to pass our component to `ComponentLayout`.\n\n`ComponentLayout` is the layout who will add all buttons (Code, Copy, Dark mode) and the live edition feature on our component.\n\n**`ComponentLayout`** take few props :\n\n-   `element`: The JSX.Element of our component\n-   `component`: The component\n-   `title`: The title of the component display on the panel\n-   `jsLink`: The link of the component codeon github (if need JS to work)\n-   `needConfiguration`: Boolean if the component/template need a custom tailwind configuration to work\n-   `vertical`: Boolean if the code preview is display on side of the component or below\n-   `showSwitchMode`: Boolean if the component have dark/light implementation (Display or hide the dark mode checkbox)\n-   `containerClasses`: Classes to add on the container of the component (ex : add margin, padding ...)\n\n| propName          | propType    | defaultValue | isRequired |\n| ----------------- | ----------- | ------------ | ---------- |\n| element           | JSX.Element |              | x          |\n| component         |             |              | x          |\n| title             | string      |              | x          |\n| jsLink            | string      |              |            |\n| needConfiguration | boolean     | false        |            |\n| vertical          | boolean     | false        |            |\n| showSwitchMode    | boolean     | false        |            |\n| containerClasses  | string      |              |            |\n\nExample of the `index.tsx` file of the **toggle** category :\n\n```JSX\nimport React, { FC } from \"react\";\nimport AppLayout from \"../../../components/layout/AppLayout\";\nimport ComponentLayout from \"../../../components/layout/ComponentLayout\";\nimport SectionHeader from \"../../../components/site/header/SectionHeader\";\nimport FormSubscribe from \"../../../components/kit/components/form/layout/FormSubscribe\";\n\nconst TogglePage: FC = () =\u003e {\n  return (\n     \u003cAppLayout\n      title=\"Toggle, Checkbox and Radio buttons components for tailwind css\"\n      desc=\"Free and open source toggle, checkbox and radio buttons components for tailwind css\"\n    \u003e\n      \u003cSectionHeader title=\"Form layout\" /\u003e\n      \u003cComponentLayout\n        title=\"Subscribe\"\n        element={\u003cFormSubscribe label=\"Subscribe\" placeholder=\"Email\" /\u003e}\n        component={FormSubscribe}\n      /\u003e\n    \u003c/AppLayout\u003e\n  );\n};\n\nexport default TogglePage;\n```\n\n## Learn More\n\nTo learn more about Next.js, take a look at the following resources:\n\n-   [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.\n-   [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n\nYou can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!\n\n## Licensing\n\n-   Copyright 2020 Charlie Rabiller\u003c/a\u003e\n\n-   Licensed under \u003ca href=\"https://github.com/Charlie85270/tail-kit/blob/main/README.md\" target=\"_blank\"\u003eMIT\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlie85270%2Ftail-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharlie85270%2Ftail-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlie85270%2Ftail-kit/lists"}