intuit / devtools-ds
UI components, libraries, and templates for building robust devtools experiences.
README
Components and tools for building browser devtools extensions, built on DS-CLI and PostCSS Themed.
Ever wanted to build your own browser extension or devtools panel? This project can help! We've built out a set of utilities and React components that let you mirror the functionality of the Chrome/FireFox developer tools.
Each component:
- Supports themes for multiple browsers
- Is fully written in TypeScript
- Aims to be keyboard accessible and screen-reader friendly
- Uses minimal external dependencies
Read more in our Storybook documentation site.
:hammer: Developer Set-up
Access source files and and make contributions using the following setup steps:
-
Clone the repo
git clone https://github.com/design-systems/devtools-ds.git cd devtools-ds -
Install dependencies
yarn -
Build
yarn build -
Start Storybook
yarn storybook
๐ค Contributing
Whether it's improving documentation, adding a new component, or suggesting an issue that will help us improve, all contributions are welcome!
Top reasons to contribute:
<ul>
<li>
<span aria-hidden style={{ marginRight: 8 }}>
๐
</span>
Empower others to build high quality browser devtools experiences
</li>
<li>
<span aria-hidden style={{ marginRight: 8 }}>
๐
</span>
Learn design system development
</li>
<li>
<span aria-hidden style={{ marginRight: 8 }}>
โณ
</span>
Help maintainers prioritize impactful work
</li>
</ul>
Here are some ideas for contributions:
- New components
- New themes (We'd love to see some Safari themes eventually)
- Accessibility improvements
- New browser extension templates
- Support for frameworks like Vue, Angular, or Svelte
For more information about contributing, read our contributing guide and code of conduct.
Contributors โจ
Thanks goes to these wonderful people (emoji key):
<table>
<tr>
<td align="center"><a href="https://github.com/tylerkrupicka">
<br /><sub><b>Tyler Krupicka</b></sub></a><br /><a href="#a11y-tylerkrupicka" title="Accessibility">๏ธ๏ธ๏ธ๏ธโฟ๏ธ</a> <a href="https://github.com/design-systems/devtools-ds/issues?q=author%3Atylerkrupicka" title="Bug reports">๐</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=tylerkrupicka" title="Code">๐ป</a> <a href="#design-tylerkrupicka" title="Design">๐จ</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=tylerkrupicka" title="Documentation">๐</a> <a href="#example-tylerkrupicka" title="Examples">๐ก</a> <a href="#infra-tylerkrupicka" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="#maintenance-tylerkrupicka" title="Maintenance">๐ง</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=tylerkrupicka" title="Tests">โ ๏ธ</a> <a href="#tool-tylerkrupicka" title="Tools">๐ง</a></td>
<td align="center"><a href="https://github.com/adierkens">
<br /><sub><b>Adam Dierkens</b></sub></a><br /><a href="#a11y-adierkens" title="Accessibility">๏ธ๏ธ๏ธ๏ธโฟ๏ธ</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=adierkens" title="Code">๐ป</a> <a href="#design-adierkens" title="Design">๐จ</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=adierkens" title="Documentation">๐</a> <a href="#example-adierkens" title="Examples">๐ก</a> <a href="#infra-adierkens" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="#maintenance-adierkens" title="Maintenance">๐ง</a> <a href="#platform-adierkens" title="Packaging/porting to new platform">๐ฆ</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=adierkens" title="Tests">โ ๏ธ</a> <a href="#tool-adierkens" title="Tools">๐ง</a></td>
<td align="center"><a href="https://github.com/ShelbyCohen">
<br /><sub><b>Shelby Cohen</b></sub></a><br /><a href="#a11y-ShelbyCohen" title="Accessibility">๏ธ๏ธ๏ธ๏ธโฟ๏ธ</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=ShelbyCohen" title="Code">๐ป</a> <a href="#design-ShelbyCohen" title="Design">๐จ</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=ShelbyCohen" title="Documentation">๐</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=ShelbyCohen" title="Tests">โ ๏ธ</a></td>
<td align="center"><a href="https://github.com/kharrop">
<br /><sub><b>Kelly Harrop</b></sub></a><br /><a href="#design-kharrop" title="Design">๐จ</a></td>
<td align="center"><a href="http://hipstersmoothie.com/">
<br /><sub><b>Andrew Lisowski</b></sub></a><br /><a href="https://github.com/design-systems/devtools-ds/commits?author=hipstersmoothie" title="Documentation">๐</a> <a href="#example-hipstersmoothie" title="Examples">๐ก</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=hipstersmoothie" title="Code">๐ป</a></td>
<td align="center"><a href="http://adrian.delarosab.me/">
<br /><sub><b>Adrian de la Rosa</b></sub></a><br /><a href="https://github.com/design-systems/devtools-ds/commits?author=mormubis" title="Code">๐ป</a> <a href="https://github.com/design-systems/devtools-ds/commits?author=mormubis" title="Documentation">๐</a> <a href="#example-mormubis" title="Examples">๐ก</a></td>
</tr>
</table>
This project follows the all-contributors specification. Contributions of any kind welcome!
