{"id":13881078,"url":"https://github.com/oruga-ui/oruga","last_synced_at":"2025-05-13T21:04:58.727Z","repository":{"id":37393875,"uuid":"268736505","full_name":"oruga-ui/oruga","owner":"oruga-ui","description":"🐛 Oruga is a lightweight Vue.js UI component library without any CSS dependency","archived":false,"fork":false,"pushed_at":"2025-05-08T08:00:24.000Z","size":17512,"stargazers_count":1147,"open_issues_count":22,"forks_count":173,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2025-05-08T08:39:16.302Z","etag":null,"topics":["agnostic","component-library","components","contributions-welcome","css","css-framework","customization","frontend","javascript","nuxt","oruga","sass","scss","tailwindcss","ui","ui-components","ux","vue","vuejs"],"latest_commit_sha":null,"homepage":"https://oruga-ui.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/oruga-ui.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null},"funding":{"ko_fi":"mlmoravek"}},"created_at":"2020-06-02T07:52:58.000Z","updated_at":"2025-05-05T07:34:19.000Z","dependencies_parsed_at":"2024-01-02T20:22:27.800Z","dependency_job_id":"82a9893d-e223-4dbf-ba8c-4210af76c89b","html_url":"https://github.com/oruga-ui/oruga","commit_stats":{"total_commits":1642,"total_committers":90,"mean_commits":"18.244444444444444","dds":0.5992691839220463,"last_synced_commit":"08a736426005157f819c1dfe2628d1df7a26cd01"},"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oruga-ui%2Foruga","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oruga-ui%2Foruga/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oruga-ui%2Foruga/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oruga-ui%2Foruga/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oruga-ui","download_url":"https://codeload.github.com/oruga-ui/oruga/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254028510,"owners_count":22002274,"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":["agnostic","component-library","components","contributions-welcome","css","css-framework","customization","frontend","javascript","nuxt","oruga","sass","scss","tailwindcss","ui","ui-components","ux","vue","vuejs"],"created_at":"2024-08-06T08:03:59.026Z","updated_at":"2025-05-13T21:04:53.718Z","avatar_url":"https://github.com/oruga-ui.png","language":"Vue","readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://oruga-ui.com\"\u003e\n        \u003cimg width=\"240\" src=\"https://github.com/oruga-ui/oruga/raw/master/packages/docs/public/logo.png\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@oruga-ui/oruga-next\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@oruga-ui/oruga-next.svg?logo=npm\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@oruga-ui/oruga-next\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/@oruga-ui/oruga-next.svg\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/oruga-ui/oruga/actions\"\u003e\u003cimg src=\"https://github.com/oruga-ui/oruga/actions/workflows/build.yml/badge.svg\" /\u003e\u003ca\u003e\n    \u003ca href=\"https://discord.gg/RuKuBYN\"\u003e\u003cimg src=\"https://img.shields.io/badge/chat-on%20discord-7289DA.svg?logo=discord\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://ko-fi.com/mlmoravek\"\u003e\u003cimg src=\"https://img.shields.io/badge/ko--fi-donate-%23FF5E5B?style=flat\u0026logo=ko-fi\u0026logoColor=white\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eOruga UI is like a caterpillar, minimal and yet functional. It's in your hands turning it into a butterfly\u003c/i\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n(🐛) =\u003e 🦋\n\u003c/p\u003e\n\n\n## Features\n\nOruga is a lightweight UI components library for [Vue.js](https://vuejs.org/) without any dependency.\nIt offers a set of easily customisable components and doesn't depend on any specific style or CSS framework (like Bootstrap, Bulma, TailwindCSS, etc...). Therefore, it doesn't provide a grid system or CSS utilities, but you can integrate any CSS framework you like.\nOruga provides you with a set of functional components, so you can focus only on the UI/UX aspects of your application and can be entirely flexible for future changes without having to touch a line of JavaScript.\n\n* **CSS framework agnostic**: No dependency on a specific CSS framework/library but you can easily integrate the components with one of them because they are fully customizable in different ways\n* **Components with steroids**: most of the components aren't a simple wrapper of native elements but they add new and custom features\n* **Lightweight**: no other internal dependency and import only components that you need\n\nIf you need a component library and want to easily apply your custom styles, Oruga is the library for you! 🐛\n\nIn addition, if you don't want to style everything yourself, we've created several [themes](https://oruga-ui.com/documentation/themes.html) to provide you with a variety of ready-to-use styles. 🦋\n\n## Documentation\n\nBrowse [online documentation here](https://oruga-ui.com/documentation/).\n\n💅 For more info about components customization, read carefully the [\"customization\" section](https://oruga-ui.com/documentation/customisation.html) in the documentation.\n\n🕹 To see Oruga in action, go to the [\"example\" section](https://oruga-ui.com/documentation/#examples) in the documentation.\n\n\u003e Note: the source code of the documentation examples can be found in the `examples` directories for each component, it serves as the demo as well.\n\n## Quick start\n\n🐛 Oruga is available for [Vue.js](https://vuejs.org/) **version 3.x** \n\n### Setup Oruga\n\n1. Install Oruga.\n\n```bash\nnpm install @oruga-ui/oruga-next\n```\n\n2. Import the components:\n\n- To get started quickly, use `Oruga` to register all components:\n\n    ```js\n    import { createApp } from 'vue'\n    import Oruga from '@oruga-ui/oruga-next';\n    \n    createApp(...).use(Oruga);\n    ```\n\n - To use tree shaking, either register component manually:\n\n    ```js\n    import { createApp } from 'vue'\n    import { OField, OInput } from '@oruga-ui/oruga'\n    \n    createApp(...)\n      .use(OField)\n      .use(OInput)\n    ```\n    \n - or [import them in your SFC](https://vuejs.org/guide/components/registration.html#local-registration).\n\n### Customization\n\nOruga's superpower is its configurability and its CSS framework agnostic approach.\nEach component can be individually customised and configured by defining specific classes using a class-mapping approach. Therefore, Oruga comes without any styling by default. However, there are several official predefined configurations called themes, which you can include and extend to give your application a individual look and feel. And all components came with predefined classes by default.\n\nPlease read the [\"customization\" section](https://oruga-ui.com/documentation/customisation.html) in Oruga documentation.\n\nIf you want to see an example with a fully customized registration form using `Tailwind`, `Bulma`, `Bootstrap`, `Material` or any other CSS framework have a look at the official [Oruga multiframework example](https://oruga-multiframework-demo.netlify.app/tailwind) (source code available [here](https://github.com/oruga-ui/demo-multiframework)) or if you're more familiar with TailwindCSS 2 give our official [TailwindCSS Demo](https://oruga-tailwindcss-demo.netlify.app/) a try (source code [here](https://github.com/oruga-ui/demo-tailwindcss))\n\n### Using Oruga with Nuxt\n\nOruga doesn't provide a [Nuxt.js](https://nuxtjs.org) module at the moment.\n\nYou can use Nuxt.js plugins system adding a file (e.g. `oruga.js`) in your `plugins` folder containing:\n\n```js\nimport Oruga from '@oruga-ui/oruga-next';\n\nexport default defineNuxtPlugin((nuxtApp) =\u003e {\n  nuxtApp.vueApp.use(Oruga);\n});\n```\n\nTo make this plugin available in your app, add this file to the `plugins` array in your `nuxt.config.js`\n\n```js\nplugins: [{ src: '~plugins/oruga.js' }]\n```\n\nTo understand how the plugins work with Nuxt.js, take a look at the [NuxtJS plugin documentation](https://nuxtjs.org/guides/configuration-glossary/configuration-plugins).\n\nTake a look at the [official NuxtJS + Oruga example](https://github.com/oruga-ui/demo-nuxtjs).\n\n## Contributing\n\nPlease see the [contributing guidelines](./.github/CONTRIBUTING.md).\n\n\n### Contact us 👾\n\n→ Join the [Oruga Discord server](https://discord.gg/RuKuBYN).\n\n\n## Versioning\n\nOruga uses [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) for package versions.\n\nWhile it's still in beta, versions will follow this pattern: **v0.Y.Z**, where:\n\n* **Y**: Major (breaking changes)\n* **Z**: Minor or patch\n\n## Core Team\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://twitter.com/walter_tommasi\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/8029488?v=4\" width=\"80px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eWalter Tommasi\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://twitter.com/4stagi\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/537363?v=4\" width=\"80px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAndrea Stagi\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/mlmoravek\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/25961416?v=4\" width=\"80px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMarcel Moravek\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Contributors\nThank you to everyone involved for improving this project, day by day 💚\n\n\u003ca href=\"https://github.com/oruga-ui/oruga\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=oruga-ui/oruga\"/\u003e\n\u003c/a\u003e\n\n[Complete list](CONTRIBUTORS.md).\n\n## Credits\n\nOruga logo designed by [Matteo Guadagnini](mailto:matteoguadagnini67@gmail.com)\n\nOruga svg images for Checkbox and Radio components and Holidays assets created by [Fabrizio Masini](https://github.com/Nemesis19)\n\n## License \u003ca href=\"https://github.com/oruga-ui/oruga/blob/master/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/@oruga-ui/oruga.svg?logo=github\" /\u003e\u003c/a\u003e\n\nCode released under [MIT](https://github.com/oruga-ui/oruga/blob/master/LICENSE) license.\n","funding_links":["https://ko-fi.com/mlmoravek"],"categories":["Vue","Components \u0026 Libraries","Frameworks [🔝](#readme)","UI Libraries \u0026 Components"],"sub_categories":["Frameworks","Courses"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foruga-ui%2Foruga","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foruga-ui%2Foruga","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foruga-ui%2Foruga/lists"}