GitHub - TotomInc/vue3-select-component: A flexible & modern select-input control for Vue 3. (original) (raw)

Vue3 Select Component

Vue3-Select-Component

Best-in-class select component for Vue 3, with a focus on DX, accessibility and ease-of-use.

npm package npm package GitHub stars

Documentation | Getting Started | Examples / Demos

Core features:

Installation

Install the package with npm:

npm i vue3-select-component

::: info The component requires its CSS styles to be imported manually.

import "vue3-select-component/styles";

:::

Use it in your Vue 3 app:

Advanced TypeScript usage

Vue 3 Select Component creates a type-safe relationship between the option.value and the v-model prop.

It also leverages the power of generics to provide types for additional properties on the options.

There's an entire documentation page dedicated to usage with TypeScript.

Contributing & Development

Getting Started

  1. Clone the repository
  2. Install dependencies: npm install
  3. Start the playground: npm run dev:playground
  4. Run tests: npm run test

Contributing

Development documentation

The dev branch documentation can be found at:

https://dev-vue3-select-component.vercel.app/

This documentation is automatically generated from the dev branch and is updated with each commit.

Note: it doesn't reflect the latest stable release.

Releases

For changelog, visit releases.

License

MIT Licensed. Copyright (c) Thomas Cazade 2024 - present.