@itwin/itwinui-variables

3.3.0 • Public • Published

@itwin/itwinui-variables

Installation

npm install @itwin/itwinui-variables

Usage

Import in CSS:

@import '@itwin/itwinui-variables';

Or in JS (if using a bundler):

import '@itwin/itwinui-variables';

Note: If your project doesn't support export maps, then you might need to import the css file explicitly:

@import '@itwin/itwinui-variables/index.css';

Specify a theme ("light" or "dark") by adding a data-iui-theme attribute to the top of your app.

<body data-iui-theme="light">
  <!-- your application code -->
</body>

Now you can start using the variables:

button {
  background-color: var(--iui-color-background);
  border: var(--iui-color-border);
  color: var(--iui-color-text);
}

You can also specify data-iui-contrast to switch to a high contrast version of the current theme.

<body data-iui-theme="dark" data-iui-contrast="high">
  <!-- your application code -->
</body>

If you want the variables to automatically respect the user preferences (prefers-color-scheme and prefers-contrast), then you need to additionally import os.css, and use data-iui-theme without a value. For example:

@import '@itwin/itwinui-variables';
@import '@itwin/itwinui-variables/os.css';
<body data-iui-theme>
  <!-- your application code -->
</body>

Package Sidebar

Install

npm i @itwin/itwinui-variables

Weekly Downloads

7,865

Version

3.3.0

License

MIT

Unpacked Size

28.9 kB

Total Files

5

Last publish

Collaborators

  • wgoehrig
  • cshafer
  • aruniverse
  • imodeljs
  • colinkerr