https://github.com/rolemodel/tailored-select
Tailored Select is a Web Component built to be a searchable select box. Inspired by tom-select.js to provide a framework agnostic autocomplete widget with native-feeling keyboard navigation. Useful for tagging, contact lists, etc.
https://github.com/rolemodel/tailored-select
Last synced: 4 months ago
JSON representation
Tailored Select is a Web Component built to be a searchable select box. Inspired by tom-select.js to provide a framework agnostic autocomplete widget with native-feeling keyboard navigation. Useful for tagging, contact lists, etc.
- Host: GitHub
- URL: https://github.com/rolemodel/tailored-select
- Owner: RoleModel
- License: mit
- Created: 2024-08-23T16:56:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T08:14:09.000Z (over 1 year ago)
- Last Synced: 2025-11-01T22:22:49.649Z (7 months ago)
- Language: JavaScript
- Size: 117 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
## Name and aliases
The project is named Tailored Select. Some will refer to it as Bob Select or Yoinker™️.
## Purpose
Tailored Select is a Web Component built to be a searchable select box. Inspired by tom-select.js to provide a framework agnostic autocomplete widget with native-feeling keyboard navigation. Useful for tagging, contact lists, etc.
## Technologies
### Chosen
- [Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components) As the foundational technology.
- [Lit](https://lit.dev/) for easily creating Web Components.
- [Vite](https://vitejs.dev/) for a fast development environment that handles developing, building, and publishing the project.
## Technology relationships
- Web Component
- Simple Form Component (TODO: link to rolemodel rails)
- Capybara test helper (TODO: link to rolemodel rails)
- Optics addon (TODO: link to optics)
## Supported browsers
This project is supported in all modern browsers.
# How to set up the project
## External tool installation
`yarn install`
## How to run locally
`yarn vite`
## How to run tests
TODO: Add tests
## Editor plugins
- TODO: Maybe add prettier?
## Testing Strategy
### Unit tests
Due to the nature of this application, unit tests are prominent and handle most of the confidence building and documentation needs of the system below the user interface.
## Testing tools
TODO: Which tools are we using?
## Branching strategy
To begin a new feature run, `git checkout -b `.
When finished with the feature and the code has been reviewed, the commits should be squashed before merging. See [RoleModel Best Practices](https://github.com/RoleModel/BestPractices) for more information.
## Deployment
A Github Action is set up to build and deploy the project to NPM and Github packages. The deployment uses the `main` branch and is triggered by creating a release.
### Local build
To build the project locally, run `yarn build`.
## Copyright & licensing
Copyright (c) 2024 Open Source @RoleModel Software