{"id":19568311,"url":"https://github.com/shuriken-ui/nuxt","last_synced_at":"2025-04-12T22:19:52.839Z","repository":{"id":153077062,"uuid":"627639960","full_name":"shuriken-ui/nuxt","owner":"shuriken-ui","description":"Nuxt version of Shuriken UI with ready to use components","archived":false,"fork":false,"pushed_at":"2024-11-08T18:56:10.000Z","size":1777,"stargazers_count":169,"open_issues_count":3,"forks_count":23,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-04T01:20:29.839Z","etag":null,"topics":["components","nuxt","nuxt3","ui"],"latest_commit_sha":null,"homepage":"https://shurikenui.com/","language":"Vue","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/shuriken-ui.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","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":"cssninjaStudio"}},"created_at":"2023-04-13T22:22:29.000Z","updated_at":"2025-03-11T09:39:56.000Z","dependencies_parsed_at":"2023-10-14T19:54:27.120Z","dependency_job_id":"cd7a67a0-1163-407b-ad71-df857453d452","html_url":"https://github.com/shuriken-ui/nuxt","commit_stats":null,"previous_names":[],"tags_count":81,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shuriken-ui%2Fnuxt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shuriken-ui%2Fnuxt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shuriken-ui%2Fnuxt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shuriken-ui%2Fnuxt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shuriken-ui","download_url":"https://codeload.github.com/shuriken-ui/nuxt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248638264,"owners_count":21137643,"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":["components","nuxt","nuxt3","ui"],"created_at":"2024-11-11T06:03:29.733Z","updated_at":"2025-04-12T22:19:52.810Z","avatar_url":"https://github.com/shuriken-ui.png","language":"Vue","funding_links":["https://github.com/sponsors/cssninjaStudio"],"categories":["Vue"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/shuriken-ui/.github/assets/86636408/278e3026-1997-4e01-9457-20772adbce31\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://github.com/shuriken-ui/.github/assets/86636408/06f9d8e2-38aa-45b2-b91e-1c891a20e271\"\u003e\n    \u003cimg alt=\"Shuriken UI logo\" src=\"https://github.com/shuriken-ui/.github/assets/86636408/06f9d8e2-38aa-45b2-b91e-1c891a20e271\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://shurikenui.com\" title=\"Shuriken UI website\"\u003e\u003cstrong\u003eshurikenui.com\u003c/strong\u003e\u003c/a\u003e | \n  by \u003ca href=\"https://cssninja.io\" title=\"Our official website\"\u003e\u003cstrong\u003ecssninja.io\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## Shuriken UI - Nuxt\n\nShuriken UI is a free and open-source Tailwind CSS UI Kit. It is a collection of components and templates that you can use to build your next Tailwind CSS project.\n\nThis repository contains the Nuxt version (a [layer](https://nuxt.com/docs/getting-started/layers)) of Shuriken UI with ready to use components (form inputs, buttons, cards, etc.) that you can use to build your  project.\n\n## Installation\n\n```bash\npnpm install -D @shuriken-ui/nuxt\n```\n\n\u003e **Note**: This also installs the [Shuriken UI Tailwind CSS](https://github.com/shuriken-ui/tailwind) package and required nuxt modules:\n\u003e\n\u003e - [@nuxtjs/tailwindcss](https://github.com/nuxt-modules/tailwindcss)\n\u003e - [@nuxtjs/color-mode](https://github.com/nuxt-modules/color-mode)\n\u003e - [@vueuse/nuxt](https://github.com/vueuse/vueuse/tree/main/packages/nuxt)\n\u003e - [nuxt-icon](https://github.com/nuxt-modules/icon)\n\n## Usage\n\n\n```ts\n// nuxt.config.ts\nexport default defineNuxtConfig({\n  extends: [\n    '@shuriken-ui/nuxt'\n  ]\n})\n```\n\n\u003e **Note**: This is a [layer](https://nuxt.com/docs/getting-started/layers) and not a module, so you must extend your nuxt config with it.\n\n## Configuration\n\n### Nuxt `app.config.ts`\n\nThis is the [app configuration](https://nuxt.com/docs/getting-started/configuration#app-configuration) for Shuriken UI components\n\n\u003e **Note**: It's not a module configuration, so you must define it in `app.config.ts`, not in `nuxt.config.ts`.\n\n```ts\nexport default defineAppConfig({\n  /**\n   * Shuriken UI layer configuration\n   */\n  nui: {\n    /**\n     * Set default properties for BaseButton component\n     */\n    BaseButton: {\n      variant: 'pastel',\n      rounded: 'md',\n    },\n\n    // ...\n  },\n})\n```\n\n\n### Tailwind `tailwind.config.ts`\n\n```ts\nimport { withShurikenUI } from '@shuriken-ui/tailwind'\nimport colors from 'tailwindcss/colors'\n\n/**\n * Shuriken UI tailwind configuration\n */\nexport default withShurikenUI({\n  content: [],\n  theme: {\n    /**\n     * Customize fonts\n     * \n     * You must load them yourself\n     * (ex: with unplugin-fonts)\n     */\n    fontFamily: {\n      sans: ['Roboto Flex', 'sans-serif'],\n      heading: ['Inter', 'sans-serif'],\n      alt: ['Karla', 'sans-serif'],\n      mono: ['ui-monospace', 'monospace'],\n    },\n    extend: {\n      /**\n       * Customize colors \n       * \n       * Use tailwind predefined colors,\n       * or generate your own with tools like https://tailwindshades.com\n       */\n      colors: {\n        // Define only the ones you want to override\n        muted: colors.slate,\n        primary: colors.violet,\n        info: colors.sky,\n        success: colors.teal,\n        warning: colors.amber,\n        danger: colors.rose,\n      },\n\n      /**\n       * Customize Shuriken UI components\n       * \n       * @see https://github.com/shuriken-ui/tailwind\n       */\n      nui: {\n        // ...\n      }\n    },\n  },\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshuriken-ui%2Fnuxt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshuriken-ui%2Fnuxt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshuriken-ui%2Fnuxt/lists"}