This project is very much WORK IN PROGRESS and all components are released as alpha version. Always define the exact version you want to use, and test for breaking changes before upgrading to a newer alpha release.
Applying design elements from this project is strictly prohibited for organisations that are not part of the Municipality of Utrecht.
This project is part of a community iniative to use NL Design System components for projects that need to adhere to the Utrecht Design System. Teams from the central Municipality of Utrecht, as well as those who are contracted by them to develop websites and apps, are able to collaborate via this project.
Include the Design Token CSS variables:
<link rel="stylesheet" type="text/css" href="https://unpkg.com/@utrecht/design-tokens/dist/index.css" />
Combine it with the latest Web Components from the NL Design System community, for example:
<script src="https://unpkg.com/@utrecht/web-component-library-stencil/dist/utrecht/utrecht.esm.js" type="module" ></script>
Then you can go ahead and see the result:
<utrecht-html-content> <h1>Page styled with NL Design System</h1> </utrecht-html-content>
For all dependencies, see what the version is you use while developing and update the URL without version to include a version number, and ensure your page keeps working even when new versions are released:
For alpha, beta and rc versions:
Above should become:
For stable versions it would become:
You need to have the following tools installed to run Storybook locally:
Open a terminal and run the following commands to check:
git --version: a relatively recent version should be installed (Git 2.28 or later)
node -v: should be at least the version defined in the
npm -v: should be at least the version defined in the
You can use any editor you'd like, but in case you use Visual Studio Code we recommend the following extensions that are useful for this project:
git checkout mainto switch to the main branch, if you previously worked in this repository.
git pullto get to the latest version of the main branch
npm installto download and install all the dependencies
npm run storybookto start Storybook
Control+Cin your terminal to stop Storybook.
First check the logs in the terminal if any error is displayed, if something doesn't work as expected.
You can run the code checks with
npm run lint to see if any code errors can be detected.
You can also check the build logs of the design tokens for errors, if you have changed Style Dictionary JSON files, by building those separately:
npm run build
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. Read our Code of Conduct if you haven't already.
This project is free and open-source software licensed under the European Union Public License (EUPL) v1.2.
For information about proprietary assets in this repository, please carefully read the NOTICE file.