The project is named Tailored Select. Some will refer to it as Bob Select or Yoinker™️.
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.
- Web Components As the foundational technology.
- Lit for easily creating Web Components.
- Vite for a fast development environment that handles developing, building, and publishing the project.
- Web Component
- Simple Form Component (TODO: link to rolemodel rails)
- Capybara test helper (TODO: link to rolemodel rails)
- Optics addon (TODO: link to optics)
This project is supported in all modern browsers.
yarn install
yarn vite
TODO: Add tests
- TODO: Maybe add prettier?
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.
TODO: Which tools are we using?
To begin a new feature run, git checkout -b <branchname>.
When finished with the feature and the code has been reviewed, the commits should be squashed before merging. See RoleModel Best Practices for more information.
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.
To build the project locally, run yarn build.
Copyright (c) 2024 Open Source @RoleModel Software