15.0.0 • Published 10 months ago

suomifi-ui-components v15.0.0

Weekly downloads
486
License
MIT
Repository
github
Last release
10 months ago

suomifi-ui-components

npm NPM WCAG PRs Welcome

Suomi.fi-styleguide in React components. Living styleguide (latest release/master-branch).

✨ Features

  • Accessibility WCAG 2.1 level AA
  • React-components with TypeScript support
  • Suomi.fi brand styles
  • Highly customizable (CSS, CSS-in-JS)

Works with React >= 16.8.0 (React 18 supported) and Styled Components >= 5.2.1. Supports TypeScript. CJS and ESM builds provided via the npm package.

Supported browser and screenreader combinations

Operating systemBrowsersScreen reader
macOSSafari, Chrome, EdgeVoiceOver
WindowsChrome, Firefox, EdgeNVDA
iOSSafariVoiceOver
AndroidChromeTalkBack

📦 Install

To install the component library

npm install suomifi-ui-components

Include required fonts as best suited for your project. You can, for example, use the following import with your global css.

@import url('https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600&display=swap');

The following fonts and variants are required: Font-family: 'Source Sans Pro', Font-weight: 300, 400, 600

Peer dependencies

You should also install the following peer dependencies.

  • React version >=16.8.0 and related dependencies and typings.
  • styled-components version >=5.2.1 and related dependencies and typings.

  • The aim is to keep dependencies up to date and use the latest available versions. We encourage you to use the latest available versions of peer dependencies.

npm install styled-components
  • If using TypeScript, version 3.8 or above is required.

  • In case TypeScript is used and skipLibCheck compiler option is set to false, also add typings for styled-components as well as react and react-dom as required by the React version used.

npm install @types/styled-components @types/react @types/react-dom

🔨 Usage

import { Button } from 'suomifi-ui-components';
<Button>Suomi.fi button</Button>;

🌊 Component variants

Components have a variant property for different versions of the component.

import { Button } from 'suomifi-ui-components';
<Button variant="secondary">This is a seconday button</Button>;

⛱ Extending styles

Components' styles can be customized with Styled Components:

styled(Button)...

or using CSS-ClassName:

<Button className="button--custom">Example</Button>
.fi-button.button--custom {
  ...;
}

Don't use !important. If really, really needed you can define styles using classNames multiple times .fi-button.button--custom.button--custom {...} for a specificity hack.

🔮 FAQ

See FAQ.md.

⌨️ Development

See DEVELOPMENT.md.

🤝 Contributing

We welcome all contributions. Please read our CONTRIBUTING.md first.

Licensing

MIT LICENSE

15.0.0

10 months ago

15.0.0-beta.3

10 months ago

14.0.1

10 months ago

15.0.0-beta.1

11 months ago

15.0.0-beta.2

11 months ago

15.0.0-beta.0

1 year ago

14.0.0

1 year ago

14.0.0-beta.2

1 year ago

14.0.0-beta.1

1 year ago

13.0.1

1 year ago

14.0.0-beta.0

1 year ago

13.0.0

2 years ago

12.0.3

2 years ago

12.0.2

2 years ago

13.0.0-beta.0

2 years ago

13.0.0-beta.1

2 years ago

12.0.1

2 years ago

10.0.3

2 years ago

10.0.4

2 years ago

12.0.0

2 years ago

11.0.0-beta.0

2 years ago

12.0.0-beta.2

2 years ago

12.0.0-beta.0

2 years ago

12.0.0-beta.1

2 years ago

11.0.0

2 years ago

11.0.1

2 years ago

10.0.0

2 years ago

10.0.1

2 years ago

10.0.2

2 years ago

9.1.0

2 years ago

10.0.0-beta.0

2 years ago

10.0.0-beta.1

2 years ago

9.1.0-beta.3

3 years ago

9.1.0-beta.1

3 years ago

9.1.0-beta.2

3 years ago

9.0.0-beta.3

3 years ago

9.0.0

3 years ago

9.1.0-beta.0

3 years ago

8.0.0-beta.0

3 years ago

8.0.0-beta.1

3 years ago

9.0.0-beta.2

3 years ago

9.0.0-beta.1

3 years ago

9.0.0-beta.0

3 years ago

8.0.1

3 years ago

8.0.0

3 years ago

7.0.0

3 years ago

7.0.0-beta.2

3 years ago

7.0.0-beta.0

3 years ago

7.0.0-beta.1

3 years ago

6.2.1

3 years ago

6.1.0

3 years ago

6.1.1

3 years ago

6.1.1-beta.0

3 years ago

6.1.0-beta.3

4 years ago

6.2.0

3 years ago

6.2.0-beta.0

3 years ago

6.2.0-beta.2

3 years ago

6.2.0-beta.1

3 years ago

6.1.0-beta.2

4 years ago

6.1.0-beta.1

4 years ago

6.1.0-beta.0

4 years ago

6.0.0

4 years ago

5.0.0

4 years ago

4.1.0-beta.0

4 years ago

4.0.0

4 years ago

4.0.0-beta.9

4 years ago

4.0.0-beta.8

4 years ago

3.0.1

4 years ago

4.0.0-beta.7

4 years ago

4.0.0-beta.6

4 years ago

4.0.0-beta.5

4 years ago

4.0.0-beta.4

4 years ago

4.0.0-beta.3

4 years ago

4.0.0-beta.2

4 years ago

4.0.0-beta.1

4 years ago

4.0.0-beta.0

4 years ago

3.0.0

4 years ago

3.0.0-beta.1

4 years ago

3.0.0-beta.0

5 years ago

2.0.0

5 years ago

1.1.0

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

0.17.0

5 years ago

0.16.1

5 years ago

0.16.0

5 years ago

0.15.2

5 years ago

0.15.1

5 years ago

0.15.0

5 years ago

0.14.0

5 years ago

0.13.0

5 years ago

0.12.0

5 years ago

0.11.0

5 years ago

0.10.0

5 years ago

0.9.0

5 years ago

0.8.0

5 years ago

0.7.0

5 years ago

0.6.1

5 years ago

0.6.0

5 years ago

0.5.0

5 years ago

0.5.0-alpha.1

5 years ago

0.4.1

6 years ago

0.4.0

6 years ago

0.3.1

6 years ago

0.2.4-fix.1

6 years ago

0.3.0

6 years ago

0.2.7-rc.2

6 years ago

0.2.7-rc.1

6 years ago

0.2.7-rc.0

6 years ago

0.2.6

6 years ago

0.2.5

6 years ago

0.2.4

6 years ago

0.2.3

6 years ago

0.2.2

6 years ago

0.2.1

6 years ago

0.2.0

6 years ago

0.1.1

6 years ago

0.1.0

6 years ago

0.0.18

6 years ago

0.0.17

6 years ago

0.0.16

6 years ago

0.0.15

6 years ago

0.0.14

6 years ago

0.0.13

6 years ago

0.0.12

6 years ago

0.0.11

6 years ago

0.0.10

6 years ago

0.0.9

6 years ago

0.0.8

6 years ago

0.0.7

6 years ago

0.0.6

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago