0.0.5 • Published 4 months ago

react-select-light v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

React Select Light

A highly composable & reusable select components for react projects

Features

This package setup will include following features.

  • Single-select
  • Multi-select
  • Searchable
  • Clearable
  • Disabled (whole box or single options)
  • Creatable in single- and multi-select
  • 100% typescript

Installation & Usage

Prerequisites

  • node >=18.4.0
  • npm >=9.x.x

Installation

To start using React Select Light, install it to your project as a dependency via

npm install react-select-light
yarn add react-select-light

then import it and add your tree structure with

import { Select } from 'react-select-light';

<Select
  options={options}
  displayValue='label'
  isMulti
  isObject
/>;

More details at the Get-Started Guide.

Hints for contributing

Built With

Vitest React

Dev Dependencies

PackageDescription
TypescriptTypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
tsupThe simplest and fastest way to bundle your TypeScript libraries. Used to bundle package as ESM and CJS modules. Supports TypeScript, Code Splitting, PostCSS, and more out of the box.
VitestA testing framework for JavaScript. Preconfigured to work with TypeScript and JSX.
StorybookStorybook is a frontend workshop for building UI components and pages in isolation.
HuskyGit hook management
Conventional CommitA specification for adding human and machine readable meaning to commit messages.
CommitlintLint commit messages
CommitizenUsing a standardized set of rules to write commits, makes commits easier to read, and enforces writing descriptive commits.
Lint StagedRun linters against staged git files and don't let 💩 slip into your code base!
ESLintA tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
PrettierAn opinionated code formatter

Development

Fork the project

Access the project directory.

cd react-select-light

Install dependencies.

npm install

Serve with hot reload at http://localhost:6006.

npm run storybook

Commands

CommandDescription
npm run devStarts the server in dev mode
npm run lintRuns ESLint on the project
npm run lint-stagedRuns Prettier on only staged (changed) files
npm run type-checkRuns TSC
npm run buildRuns build production bundle to 'dist' directly

License

This project uses MIT license: License