@nrk/core-icons ·

Icon and logo kit providing a consistent and predictable user experience across platforms and NRK services

Documentation

https://static.nrk.no/core-icons/latest/

Local development

First clone @nrk/core-icons and install its dependencies:

git clone [email protected]:nrkno/core-icons.git
cd core-icons
# Install dependencies according to package-lock-file
npm ci
npm start # Your browser will open documentation with hot reloading

Figma sync

1. Automatic configuration with direnv and vault

1. Install and set up direnv
2. Install and set up HashiCorp vault cli
3. Run cp .env.example .env and set the variables. Vault paths should start with secret/
4. Run direnv allow in the repository root

2. Manual configuration

1. Set the exported variables from .envrc in your environment.

Building and committing

After having applied changes, remember to build before commiting and pushing your changes upstream.

See Conventional Commits for commit guidelines.

git checkout -b feature/my-changes
# Update the source code
npm run build
# Test to ensure integrity
npm run test
git commit -am "<type>[optional scope]: <desciption>"
git push --set-upstream origin feature/my-changes
# Make a PR to the master branch,
# Assign a developer to review your code

nvm

Uses Node Version Manager (nvm) to organize node version

nvm config is saved in .nvmrc, set appropriate node version using:

nvm use

Android

See the installation guide and usage guide.

Local development

• gradlew publishToMavenLocal builds and publishes a new version locally on your machine that can be used in other projects

Icons with rendering artifacts

If an icon has artifacts or other rendering bugs in a different project you should:

• Ask a designer for an updated icon (see for instance this PR which fixed two logos with rendering artifacts)
• Add the icon the relevant folder locally
• Run through the steps above to build a new version of the library locally and use this in your project. Do not test the new icon by manually importing it into your project which uses Android Studios SVG -> XML conversion. The issue might be partly with the way the library converts the SVG, the icon might look normal when manually importing it
• If the new icon looks good open a PR with only the updated SVGs. Stash the XML drawable changes and let the Github action publish a new version of the library