2.0.2 • Published 1 year ago

@belastingdienst/bldc-themes v2.0.2

Weekly downloads
-
License
EUROPEAN UNION PU...
Repository
github
Last release
1 year ago

Bldc Themes package

This package contains color variables in CSS, SCSS, JavaScript and JSON formats. The variables are extracted from the Figma library, transformed to usable formats, and published as this package.

Rijkshuisstijl and bldc colors

The variables in this package are split in two categories:

  • The base colors, which are general purpose hex colors taken directly from the Rijkshuisstijl styles.
  • The theme colors, which are bldc component-specific variables. These variables are created specifically for bldc-components and are semantically named for theming purposes.

By default the bldc components come with backup styling in the color schema of the Belastingdienst light mode. To change the colors of your bldc components, import one of the css themes from this package into your css, and place that class on the body of your page. For example, adding the .belastingdienst-dark class changes the colors to the new Dark Mode.

Getting started

Setup

You'll need Git and Node.js installed to get this project running.

Note: You will need the active LTS (Long-term support) Node.js version for this project.

Using nvm (optional)

Working on multiple Node.js projects often means dealing with various versions of Node.js and npm specific to each project.

For seamless version management, we recommend using nvm (Node Version Manager), which allows for easy switching between Node.js versions.

Steps to follow:

  1. Install nvm on your system.
  2. In your project's root directory, execute nvm install to automatically select the correct Node.js version as specified in your project's .nvmrc file.

Clone repository

git clone git@github.com:belastingdienst/bldc-themes.git # or clone your own fork

cd bldc-themes

Run Local

Install npm dependencies

npm install

Compile and run

Run:

npm run start

NPM Scripts

ScriptDescription
startStart the compile process to generate new stylesheets
testUnit tests the application
sbomGenerate an SBOM file. This is uploaded within Dependency Track after a release.

Security

The Dutch Tax and Customs Administration promotes the practice of responsible vulnerability disclosure. If you discover a vulnerability, we encourage you to report it to us so we can address it promptly.

For details on how to report a security vulnerability, please refer to our security policy.


License

Licensed under the EUPL 1.2.


Contributing

To learn how to help us build our Design System, see our contribution guidelines.

The bldc-themes repository is an open source project. We believe in the power of collaboration and open source philosophy to improve government digital services. By sharing our design system, we invite other agencies to benefit from our work and contribute back their improvements and innovations. This collaborative effort will enrich the system, making it more robust, versatile, and user-friendly.

Contributors to the bldc-themes repository are expected to follow the Contributor Covenant Code of Conduct and to the Code of Conduct Integrity Central Government.

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago