Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dulajkavinda/commandk
🎯 A compact React component and npm package enabling quick website search through a modal, triggered by pressing Command + K
https://github.com/dulajkavinda/commandk
babel jest npm-package react react-testing-library rollup storybook
Last synced: 3 months ago
JSON representation
🎯 A compact React component and npm package enabling quick website search through a modal, triggered by pressing Command + K
- Host: GitHub
- URL: https://github.com/dulajkavinda/commandk
- Owner: dulajkavinda
- License: mit
- Created: 2023-08-01T16:28:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-05T00:36:28.000Z (over 1 year ago)
- Last Synced: 2024-10-12T15:21:48.318Z (4 months ago)
- Topics: babel, jest, npm-package, react, react-testing-library, rollup, storybook
- Language: TypeScript
- Homepage: https://npmjs.com/package/commandk
- Size: 736 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CommandK
https://github.com/dulajkavinda/commandK/assets/47476282/50fdeb37-bb72-49a7-9869-4be8b3b0c161
A compact React component and npm package enabling quick website search through a modal, triggered by pressing Command + K
## Table of contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Data](#data)
- [API](#api)
- [Accessibility](#accessibility)
- [Local Development](#local-development)
- [Contributing](#contributing)
- [License](#license)
## Features
Currently, commandK supports the following:
- [x] Open the popup using `Command` + `K`
- [x] Filter items based on search terms
- [x] Supports 3 sizes for the modal (medium, large and small)
- [x] Supports custom styles
- [x] Navigation with keyboard
- [x] Mobile responsive
- [ ] Light mode support
You can suggest new features [here](https://github.com/dulajkavinda/commandK/issues)
## Installation
### Package Managers
```bash
# npm
npm i commandk
# yarn
yarn add commandk
# pnpm
pnpm i commandk
```
## Usage
```js
import { CommandK } from 'commandk'
```
Or you can access the `Modal` component and `Button` component separately and implement your own logic.
```js
import React from "react"
import { Modal, Button } from 'commandk'
const App = () => {
const [isOpen, setIsOpen] = React.useState(false);
return (
<>
{isOpen && setIsOpen(false)} />}
setIsOpen(true)} />
>
)
}
export default App;
```
### Data
Structure of the data that's taken by the component,
**TS Definition**
```js
export interface Item {
icon: string
title: string
url?: string
}
interface Group {
sectionName: string
items: Item[]
}
```
**Sample**
```js
const list: Group[] = [
{
sectionName: 'Repositories',
items: [
{
icon: '🗂',
title: 'This is a test title',
url: '/repo',
},
{
icon: '🚀',
title: 'This is another one to check',
url: 'https://google.lk',
},
],
},
]
```
## API
### CommandK
| Parameter | Description | Type | Default |
| ---------------------------- | --------------------------------------------------------- | ---------------------------- | ---------------- |
| data | data needed to populate the search modal | Array | [] |
| keyLetter | key that needs be appear on the button | string | `K` |
| buttonSize | size of the button | `small` `medium` `large` | `medium` |
| modalSize | size of the modal | `small` `medium` `large` | `medium` |
| username | name of the search modal | string | home |
| perSectionLimit | limit numner of items in a section | number | - |
| hideButton | hide the button | boolean | `false` |
| customStyles | the style of the component | Object | {} |
### Modal
| Parameter | Description | Type | Default |
| ---------------------------- | --------------------------------------------------------- | ---------------------------- | ---------------- |
| data | data needed to populate the search modal | Array | [] |
| isOpen | to open and close the modal | boolean | `false` |
| size | size of the modal | `small` `medium` `large` | `medium` |
| username | name of the search modal | string | home |
| perSectionLimit | limit numner of items in a section | number | - |
| toggle | close the modal | Function | () => null |
### Button
| Parameter | Description | Type | Default |
| ---------------------------- | --------------------------------------------------------- | ---------------------------- | ---------------- |
| keyLetter | key that needs be appear on the button | string | `K` |
| size | size of the modal | `small` `medium` `large` | `medium` |
| styles | the style of the component | Object | {} |
| hide | hide the button | boolean | `false` |
| toggle | open the modal | Function | () => null |
## Local Development
The `main` branch contains the latest version of the CommandK component.
To begin local development:
1. `yarn install`
2. `yarn run storybook`
Storybook will appear on on http://localhost:6006
You can run `yarn test` to execute the test suite and linters. To help you develop the component we’ve set up some tests that cover the basic functionality (can be found in `/__tests__`).
To check the test coverage you can run `yarn coverage`.
## Accessibility
### Keyboard support
- _Down_: Navigate through the searched items
- _Up_: Navigate through the searched items
- _Enter_: Jump to the selected page/url
- _Command/K_: open and close the search modal
## Contributing
Contributions are welcome! If you have any ideas, bug reports, or feature requests, please submit them through the GitHub issue tracker. If you would like to contribute code, follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.
## License
This project is licensed under the MIT License. You can find more information in the [LICENSE](https://github.com/dulajkavinda/commandK/blob/main/LICENSE) file.
#
If you need to reach out to me [contact me](mailto:[email protected]).