superkey

KO | EN

gitlite — search

#python #ai #typescript #llm #golang #rust #nodejs #macos #java #cli #vue #pytorch #openai #open-source

(★ 141)

🔭 A beautifully command menu for React. Built with headlessUI.

파일 탐색기

최종 버전 다운로드 (.zip)

- config.json
- - publish.yml
- FUNDING.yml
- - command-input.mdx
  - command-list.mdx
  - command-option.mdx
  - command.mdx
  - default-colors.mdx
  - getting-started.mdx
  - nextjs.mdx
  - remix.mdx
  - snippets.mdx
- - manifest.json
- .eslintrc.js
- .gitignore
- contentlayer.config.ts
- next-seo.config.ts
- next.config.js
- package.json
- postcss.config.js
- tailwind.config.js
- tsconfig.json
- - .eslintrc.json
  - next-env.d.ts
  - next.config.js
  - package.json
  - tsconfig.json
- - .eslintrc.js
  - package.json
  - remix.config.js
  - remix.env.d.ts
  - server.js
  - tsconfig.json
- - index.html
  - package.json
  - tsconfig.json
  - tsconfig.node.json
  - vite.config.ts
- - .swcrc
  - package.json
  - tailwind.config.cjs
  - tsconfig.json
- - index.js
  - package.json
- - package.json
  - tailwind.config.js
- - base.json
  - nextjs.json
  - package.json
  - react-library.json
  - README.md
.eslintrc.js
.gitignore
LICENSE
package.json
README.md
turbo.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p></p>

<a href="https://superkey.vercel.app/docs/getting-started">Getting Started</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://github.com/pheralb/superkey/tree/main/examples">Examples</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="#-contributing">Contribute</a>

![Superkey Minzip Package Size](https://img.shields.io/bundlephobia/minzip/superkey)
![GitHub releases](https://img.shields.io/github/release/pheralb/superkey)
![GitHub stars](https://img.shields.io/github/stars/pheralb/superkey)
![GitHub issues](https://img.shields.io/github/issues/pheralb/superkey)
![GitHub license](https://img.shields.io/github/license/pheralb/superkey)

</div>

## 👋 Introduction

[**Superkey**](https://superkey.vercel.app/) is a stylized command palette component built with [React](https://reactjs.org/), [Tailwind CSS](https://tailwindcss.com/) & [HeadlessUI](https://headlessui.com/) ready to be used in your next project.

## ✨ Features

- ✅ **Easy to install**.
- ✅ **Support for keyboard navigation**.
- ✅ **Fully customizable**.
- ✅ **Fully tested, typed and reliable**.

## 👨‍🚀 Getting Started

1. **Install Superkey:**

```bash
# with npm:
npm install superkey @headlessui/react

# with yarn:
yarn add superkey @headlessui/react

# with pnpm:
pnpm install superkey @headlessui/react

# with ultra:
ultra install superkey @headlessui/react
```

2. **Add styles:**

```jsx
import "superkey/styles.css";
```

3. Create your first command palette component:

```jsx
import { useState } from "react";
import { Command, CommandInput, CommandList, CommandOption } from "superkey";

- 📚 [All docs here](https://superkey.vercel.app/docs/getting-started).

## 🤝 Contributing

1. [Fork](https://github.com/pheralb/superkey/fork) and clone the repository:

```bash
git clone git@github.com:your-username/superkey.git
```

2. Install dependencies:

```bash
npm install
# or
yarn install
# or
ultra install
# or
pnpm install
```

3. Run [turborepo](https://turbo.build/repo):

```bash
npm run dev
# or
yarn dev
# or
ultra dev
# or
pnpm dev
```

- Open [http://localhost:3000](http://localhost:3000) with your browser to see app.

## 🔧 Stack

- [Tailwind CSS](https://tailwindcss.com/) - Rapidly build modern websites without ever leaving your HTML.
- [Headless UI](https://headlessui.com/) - Completely unstyled, fully accessible UI components.
- [Next.js + Contentlayer](https://www.contentlayer.dev/) - Content made easy for developers.
- [SWC](https://swc.rs/) - Rust-based platform for the Web.

## 🔑 License

- [MIT](https://github.com/pheralb/superkey/blob/main/LICENSE).

superkey

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

superkey

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README