Skip to content

Commit

Permalink
Merge branch 'develop' into feature/DES-739-date-input-types
Browse files Browse the repository at this point in the history
  • Loading branch information
RubenSibon authored Jun 14, 2024
2 parents 8445441 + 4b55ff5 commit 757b398
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 18 deletions.
7 changes: 6 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,12 @@
"plugins": ["@typescript-eslint", "import", "jest"]
},
{
"extends": ["plugin:react/recommended", "eslint-config-prettier", "./.eslintrc.ts.json"],
"extends": [
"plugin:react/recommended",
"eslint-config-prettier",
"./.eslintrc.ts.json",
"./.eslintrc.react.json"
],
"files": ["*.ts", "*.tsx"],
"parser": "@typescript-eslint/parser",
"parserOptions": {
Expand Down
5 changes: 2 additions & 3 deletions documentation/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,8 @@ To fix this, check whether any closed PRs still have the `autorelease: pending`

## Dependencies between packages

We’ve established dependencies between our packages for smoother installation.
For instance, our React package relies on our CSS package.
When you install our React package, the corresponding version of our CSS package is automatically included.
We’ve established dependencies between our packages to avoid version mismatches.
For instance, our React package requires a specific version of our CSS package.

Here’s the dependency structure:

Expand Down
8 changes: 0 additions & 8 deletions packages/react/.eslintrc.json

This file was deleted.

10 changes: 4 additions & 6 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The `@amsterdam/design-system-react` package contains React implementations of v
You can use this package in React apps.

The design tokens and CSS used in these components are published in separate npm packages,
which are automatically installed when you install the React package.
so don’t forget to install and include `@amsterdam/design-system-tokens` and `@amsterdam/design-system-css` too.

## Stability of the components

Expand All @@ -19,20 +19,18 @@ You can then schedule an upgrade to the latest version when you have time to tes

## Getting started

Install the React package:
Install the packages you need, for instance:

`npm install @amsterdam/design-system-react`

This will automatically add separate packages containing our design tokens, assets, icons, and stylesheets.
`npm install @amsterdam/design-system-assets @amsterdam/design-system-tokens @amsterdam/design-system-css @amsterdam/design-system-react @amsterdam/design-system-react-icons`

Import the components and stylesheets you need, for example:

```javascript
import { Paragraph } from "@amsterdam/design-system-react";

import "@amsterdam/design-system-tokens/dist/index.css";
import "@amsterdam/design-system-assets/font/index.css";
import "@amsterdam/design-system-css/dist/index.css";
import "@amsterdam/design-system-tokens/dist/index.css";

function App() {
return <Paragraph>Hello world</Paragraph>;
Expand Down

0 comments on commit 757b398

Please sign in to comment.