https://github.com/tanvir0604/vue3-select

A select2 component for vue3
https://github.com/tanvir0604/vue3-select

Last synced: about 4 hours ago
JSON representation

A select2 component for vue3

• Host: GitHub
• URL: https://github.com/tanvir0604/vue3-select
• Owner: tanvir0604
• License: mit
• Created: 2023-11-18T16:58:52.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-21T17:24:09.000Z (12 months ago)
• Last Synced: 2024-08-21T09:13:39.300Z (3 months ago)
• Language: Vue
• Size: 18.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vue3-select

> A vue3 component to create a searchable select menu

## Getting Started

These instructions will help you to install the package on your local machine and create a server side pagination system in a minute.

## Installation

installation process is very simple:

```sh

$ cd VUE3PROJECT

$ npm i @shafkat/vue3-select

```

## Usage

### Import the component

```sh

$ import { Select } from "@shafkat/vue3-select";

$ import "@shafkat/vue3-select/style.css"

```

### Use the component

```sh

$ 

```

## API

#### Props

| Name       | Type   | Default | Details                                                 |

|------------|--------|---------|---------------------------------------------------------|

| options    | Array  | []      | Required - A list of data to generate the options       |

| class-name | String | NULL    | Optional - Change the css design according to your need |

Example:

```tsx

    import { ref } from "vue";

    import { Select } from "@shafkat/vue3-select";

    import "@shafkat/vue3-select/style.css"

    let options = ref([

        {name: "Atlantic", value: "A"},

        {name: "Atlantica", value: "B"},

        {name: "Cat", value: "C"},

        {name: "Catarpillar", value: "D"},

        {name: "Elephant", value: "E"},

        {name: "Elephant nose", value: "F"}

    ]);

    let value = ref("C");

    


        

            

                Disabled fieldset example

                


                    Input

                    

                

                


                    Select menu

                    

                

                Submit

            

        

    


```

> include bootstrap >= 5.0 for styling

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

1.  Fork it!

2.  Create your feature branch: `git checkout -b my-new-feature`

3.  Add your changes: `git add .`

4.  Commit your changes: `git commit -am 'Add some feature'`

5.  Push to the branch: `git push origin my-new-feature`

6.  Submit a pull request :sunglasses:

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/tanvir0604/vue3-select/tags).

## Authors

* **Md Shafkat Hussain Tanvir** - *Initial work* - [tanvir](https://github.com/tanvir0604)

See also the list of [contributors](https://github.com/tanvir0604/vue3-select/contributors) who participated in this project.