@guildeducation/recess-modal v1.0.2

recess-modal

This is Guild's variation of @material-ui's Dialog and corresponding components. Most of the components in this library simply extend the @material-ui version and apply some Guild styling, however there are some components in this library that you won't find in @material-ui.

Running locally

Use yarn storybook to have a local instance of storybook start running. From there you can explore the documentation for the table.

Gotchas

When consuming this library, make sure to either wrap your app in the @material-ui ThemeProvider or the ThemeProvider included in this library. We opted to have consumers be responsible for the theming in order to prevent potentially having many providers in one app. The ThemeProvider that we expose takes theme as a prop and defaults to @guildeducationinc/recess-theme.

While @material-ui is built with accessiblity as a core component, it is possible for you to build components that are inaccesible. In order to avoid this, please make sure you are composing your components in a symantically correct way and providing the necessary aria attributes.

Getting support

Stop by the #insert channel name Slack channel for anything you need help with. The team that built this (Search and Discovery) are all members of that channel and it is the quickest way to get your issue resolved.

Contributing

If you find something that needs to be fixed or would like to see a new feature in the library, please make whatever changes need to be made! Everything is set up to make sure your commits conform to our desired pattern and versions are released automatically after the code gets to main. Once your code is ready for review, just ping the #insert channel name channel.

Releases

The project is set up to generate releases and update the CHANGELOG.md file on pushes to main. This happens by way of semantic-release and a GitHub action that runs on pushes to main.

In order for your changes to be picked up by semantic-release commit messages need to follow the format of:

$ git commit -m '[type]([optional-scope]): [commit message]'
$ git commit -m 'fix: something was fixed'

Commit types