faqs.md

FAQs

• How come my components are not loading with the proper styles?

  • Make sure you are importing the needed CSS before trying to use any of the React components. See styles and assets documentation for more detail. If something is unclear or seems broken, please file an issue.

• How do I use a component from this library?

  • Most components are standalone and can be dropped into your codebase anywhere. Assuming that you have imported the library and styles properly, please reference the project Storybook to learn how to use the component in your code. Click any of the component stories and you can "Show Code" to see the usage of the component in context. Storybook also has a tab on each story called "Docs" which will allow you to see full documentation of the types of props you can use.

• If something is not behaving as it should, or if I believe I've spotted a problem, where should I open an issue?

  • If a react-uswds component is displaying or behaving unexpectedly there may be an issue with the react-uswds, however the issue may exist within the USWDS itself. For the fastest, most effective resolution of the issue we recommend verifying if the issue is present in the base USWDS component(s) first.
    • If so, please file the issue directly within the USDWS Github repository.
    • If not, please file an issue with us.

• What's next? What is the roadmap for this project?

  • This library is active development. We use this library on our own projects at Truss and with clients. Follow library development and maintenance work in the react-uswds Github project. In addition, reference the milestones to track parity with various USWDS versions. There is no singular roadmap; our progress is shaped by those who contribute to the library, and by changes in the uswds specification. If you have work you'd like to see done earlier/sooner, please submit a PR. We welcome your contribution!

• Why are my unit tests failing with a "Error: Your focus-trap must have at least one container with at least one tabbable node in it at all times" error?

  • Due to issues between focus-trap-react and jsdom, accomodations must be made in order for unit tests rendering the Modal component to not fail. Please read more here