{"id":13830245,"url":"https://github.com/pheralb/superkey","last_synced_at":"2025-04-10T11:24:17.005Z","repository":{"id":62376629,"uuid":"557492112","full_name":"pheralb/superkey","owner":"pheralb","description":"🔭 A beautifully command menu for React. Built with headlessUI.","archived":false,"fork":false,"pushed_at":"2023-06-24T18:58:28.000Z","size":3892,"stargazers_count":135,"open_issues_count":0,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T10:11:43.804Z","etag":null,"topics":["command-menu","component","hacktoberfest","headlessui","nextjs","react","reactjs","tailwind","tailwindcss","turbo"],"latest_commit_sha":null,"homepage":"https://superkey.vercel.app","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/pheralb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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":"pheralb"}},"created_at":"2022-10-25T19:37:57.000Z","updated_at":"2025-03-22T23:12:01.000Z","dependencies_parsed_at":"2024-08-04T10:12:48.357Z","dependency_job_id":null,"html_url":"https://github.com/pheralb/superkey","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Fsuperkey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Fsuperkey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Fsuperkey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Fsuperkey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pheralb","download_url":"https://codeload.github.com/pheralb/superkey/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208612,"owners_count":21065203,"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":["command-menu","component","hacktoberfest","headlessui","nextjs","react","reactjs","tailwind","tailwindcss","turbo"],"created_at":"2024-08-04T10:00:57.772Z","updated_at":"2025-04-10T11:24:16.985Z","avatar_url":"https://github.com/pheralb.png","language":"TypeScript","funding_links":["https://github.com/sponsors/pheralb"],"categories":["Libraries","TypeScript"],"sub_categories":["React"],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"https://superkey.vercel.app/\"\u003e\n\u003cimg src=\"./docs/public/img/banner_gh.png\" /\u003e\n\u003c/a\u003e\n\n\u003cp\u003e\u003c/p\u003e\n\n\u003ca href=\"https://superkey.vercel.app/docs/getting-started\"\u003eGetting Started\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://github.com/pheralb/superkey/tree/main/examples\"\u003eExamples\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"#-contributing\"\u003eContribute\u003c/a\u003e\n\n![Superkey Minzip Package Size](https://img.shields.io/bundlephobia/minzip/superkey)\n![GitHub releases](https://img.shields.io/github/release/pheralb/superkey)\n![GitHub stars](https://img.shields.io/github/stars/pheralb/superkey)\n![GitHub issues](https://img.shields.io/github/issues/pheralb/superkey)\n![GitHub license](https://img.shields.io/github/license/pheralb/superkey)\n\n\u003c/div\u003e\n\n## 👋 Introduction\n\n[**Superkey**](https://superkey.vercel.app/) is a stylized command palette component built with [React](https://reactjs.org/), [Tailwind CSS](https://tailwindcss.com/) \u0026 [HeadlessUI](https://headlessui.com/) ready to be used in your next project.\n\n## ✨ Features\n\n- ✅ **Easy to install**.\n- ✅ **Support for keyboard navigation**.\n- ✅ **Fully customizable**.\n- ✅ **Fully tested, typed and reliable**.\n\n## 👨‍🚀 Getting Started\n\n1. **Install Superkey:**\n\n```bash\n# with npm:\nnpm install superkey @headlessui/react\n\n# with yarn:\nyarn add superkey @headlessui/react\n\n# with pnpm:\npnpm install superkey @headlessui/react\n\n# with ultra:\nultra install superkey @headlessui/react\n```\n\n2. **Add styles:**\n\n```jsx\nimport \"superkey/styles.css\";\n```\n\n3. Create your first command palette component:\n\n```jsx\nimport { useState } from \"react\";\nimport { Command, CommandInput, CommandList, CommandOption } from \"superkey\";\n\nfunction App() {\n  const [open, setOpen] = useState(false);\n  return (\n    \u003cCommand\n      open={open}\n      onClose={() =\u003e {\n        setOpen(false);\n      }}\n    \u003e\n      \u003cCommandInput\n        onChange={(e) =\u003e {\n          console.log(e.target.value);\n        }}\n      /\u003e\n      \u003cCommandList\u003e\n        \u003cCommandOption value=\"Option 1\"\u003e\n          \u003ch1\u003eOption 1\u003c/h1\u003e\n          \u003cp\u003eDescription\u003c/p\u003e\n        \u003c/CommandOption\u003e\n        \u003cCommandOption value=\"Option 2\"\u003e\n          \u003ch1\u003eOption 2\u003c/h1\u003e\n          \u003cp\u003eDescription\u003c/p\u003e\n        \u003c/CommandOption\u003e\n      \u003c/CommandList\u003e\n    \u003c/Command\u003e\n  );\n}\n```\n\n- 📚 [All docs here](https://superkey.vercel.app/docs/getting-started).\n\n## 🤝 Contributing\n\n1. [Fork](https://github.com/pheralb/superkey/fork) and clone the repository:\n\n```bash\ngit clone git@github.com:your-username/superkey.git\n```\n\n2. Install dependencies:\n\n```bash\nnpm install\n# or\nyarn install\n# or\nultra install\n# or\npnpm install\n```\n\n3. Run [turborepo](https://turbo.build/repo):\n\n```bash\nnpm run dev\n# or\nyarn dev\n# or\nultra dev\n# or\npnpm dev\n```\n\n- Open [http://localhost:3000](http://localhost:3000) with your browser to see app.\n\n## 🔧 Stack\n\n- [Tailwind CSS](https://tailwindcss.com/) - Rapidly build modern websites without ever leaving your HTML.\n- [Headless UI](https://headlessui.com/) - Completely unstyled, fully accessible UI components.\n- [Next.js + Contentlayer](https://www.contentlayer.dev/) - Content made easy for developers.\n- [SWC](https://swc.rs/) - Rust-based platform for the Web.\n\n## 🔑 License\n\n- [MIT](https://github.com/pheralb/superkey/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpheralb%2Fsuperkey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpheralb%2Fsuperkey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpheralb%2Fsuperkey/lists"}