@aram-limpens/design-system-css
v0.7.5
Published
CSS files for components for the City of Amsterdam based on the NL Design System architecture
Downloads
6
Readme
DEPLOY TEST 9
CSS components are developed using BEM class names and the stylesheets can be included in your page without side-effects. Apply the class names to your elements to make them stylable using design tokens.
npm install @aram-limpens/design-system-css
Theoretically you can include the components in your HTML page like so, but this is not the typical use case of this library:
<!doctype html>
<html lang="en">
<head>
<title>Example page</title>
<link rel="stylesheet" href="node_modules/@aram-limpens/design-system-css" />
</head>
<body>
<p class="ams-paragraph">Hello, world!</p>
</body>
</html>The BEM class names can be particularly useful to include only the CSS you need using CSS modules (in React).
import React from "react";
import style from "@aram-limpens/design-system-css";
export default class ExamplePage extends React.Component {
render() {
return (
<>
<p className={btn["ams-paragraph"]}>Hello, world!</p>
</>
);
}
}Compact mode
For applications, the large text and ample white space of the theme can be counterproductive. That’s why there is a compact mode. To use the compact mode, import the compact css after theme css, like so:
import "@aram-limpens/design-system-tokens/dist/index.css";
import "@aram-limpens/design-system-tokens/dist/compact.css";Global styles
Some elements of your document are out of reach for the Design System components. However, their styles can influence the appearance of the components.
Base font size
Do not change the base font-size – e.g. through html { font-size: 62.5% }.
Out typography system expects 1rem to be the browser default of 16 pixels.
If your application does use a rule like this and you can’t easily remove it, adopt the Design System components gradually by setting font-size: 100% on the parts that use them.
Remove body margin
If you haven’t removed the margin on the <body> element that browsers set by default, you can add our ams-body class to it to do so.
Use our extra bold font weight
We only use the regular and extra bold weights of our font, Amsterdam Sans.
Apply font-weight: var(--ams-text-font-weight-bold) to elements that display bold text, e.g. b, strong, and dt.