@dso-toolkit/react v66.1.0

• Slack chat
• Slack chat invite link

DSO Toolkit - Design System van het Digitaal Stelsel Omgevingswet (DSO)

De DSO Toolkit bestaat uit documentatie en een stijlgids. Daarnaast worden er twee implementaties geleverd: CSS en Web Components. De Web Components krijgen voor Angular en React wrappers, zie issue #915.

De deliverables van de DSO Toolkit:

• Handleiding: Een handleiding voor elke versie op https://www.dso-toolkit.nl/
• CDN: Een CDN op https://cdn.dso-toolkit.nl/, voor documentatie zie verderop in deze README
• NPM package @dso-toolkit/styling: Een incomplete CSS implementatie van de DSO stijlset geschreven in SCSS
• NPM package dso-toolkit: De handleiding en complete CSS implementatie van de DSO stijlset.

We zijn bezig met het verhuizen van de styling van dso-toolkit naar @dso-toolkit/styling. Zodra die verhuizing is afgerond zal dso-toolkit worden deprecated en moeten implementaties overstappen naar @dso-toolkit/styling. De componenten zoals die worden aangeboden op https://www.dso-toolkit.nl/ blijven functioneren. Voor meer informatie zie #827

Getting started

Stable releases can be found on the GitHub Releases page.

NPM registry

npm install dso-toolkit --save-dev

1. Add node_modules/dso-toolkit/libs and node_modules as include paths to your SASS compiler/wrapper (See #105 for more information)
2. Bundle /node_modules/dso-toolkit/src/dso.scss in your build process.

The Web Components are not yet available as NPM package, see #827 and #885. In the meantime you could use the <script>-tag mentioned below.

CDN

The toolkit and component library are distributed to dso-toolkit.nl. Use the table below to resolve the branch/channel to the base url:

The same goes for the component library:

<link rel="stylesheet" href="https://cdn.dso-toolkit.nl/[master|VERSION]/styles/dso.css" />

For Web Components:

<script type="module" src="https://cdn.dso-toolkit.nl/[master|VERSION]/core/dso-toolkit.esm.js"></script>
<script nomodule src="https://cdn.dso-toolkit.nl/[master|VERSION]/core/dso-toolkit.js"></script>

The referenced scripts are very small: Only the actually used Web Components are lazy loaded. For more information: https://stenciljs.com/docs/distribution

Develop or mockups

To work on the DSO Toolkit using components and variants or create mockups of pages, forms or components you need Node 12 and Yarn 2.

Either install Yarn with

npm install --global yarn

or use Yarn with npx:

npx yarn <<<my commands here>>>

git clone git@github.com:dso-toolkit/dso-toolkit.git
cd dso-toolkit
yarn install
yarn start

A local webserver is started at http://localhost:3000/. See the Fractal guide on how to develop components. See CONTRIBUTING.md on how to contribute.

Requirements

Node 12. For development on the DSO Toolkit you also need Yarn.

Dependencies

The DSO Toolkit and Component Library uses

• npm as the registry for node packages
• yarn for package management
• gulp for build automation
• node-sass to compile sass to css
• fractal to document the toolkit
• yaml to configure fractal components

Further reading

• https://www.npmjs.com/
• https://github.com/sass/node-sass
• http://fractal.build/
• http://keepachangelog.com/en/1.0.0/
• http://semver.org/
• http://handlebarsjs.com/
• http://www.yaml.org/