Fork the repo, then clone your fork to your machine and run:
npm installTo test in the browser during development, run:
npm startThen open your browser to http://localhost:9966
When you're done with your changes, be sure to run npm run format to have Prettier format your code, and use npm run lint to check for syntax issues. npm run test:e2e:dev will run e2e tests in interactive mode.
You can also simply run npm test to check all of the above.
If you added/removed options in the API, please remember to update the docs in the README as well as the typings.
Before posting your PR, please add a changeset by running npx changeset and following the prompts. This will help us quickly make a release with your enhancements.
If your changes don't affect the source or typings, then a changeset is not needed (and you can ignore the bot's automated comment on your PR about not finding one as part of your changes).
We want to recognize all contributions. To that end, we use the All Contributors Bot to automate adding all types of contributions to our README.
You can also use the All Contributors CLI instead of the bot: npm run all-contributors add <USERNAME> <KEY>[,<KEY>...] (where KEY is an emoji key contribution term). Then run npm run all-contributors generate to update the README.
Please feel free to use the bot on your own issue or PR to add yourself as a contributor (or use the CLI), or remind one of the maintainers to do so.
✨ No contribution is too small not to be included. We appreciate your help!
The docs are published at http://focus-trap.github.io/focus-trap/ and served from the /docs directory in the repo.
Simply run npm run demo-bundle locally, commit the updated /docs/demo-bundle.* files (note that other /docs/demo-bundle-[debug,cypress].* bundles may exist, but they are git-ignored and should not be committed), and open a PR to updated it.
Ideally, this is done within any PR that modifies anything under /docs, or the library code itself.