Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Info om kompilert css i Readme #2423

Merged
merged 22 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
5a12b4a
docs(ffe-accordion): info om import av css
antidecaf Nov 19, 2024
35e8e08
docs(ffe-account-selector-react): info om import av css
antidecaf Nov 19, 2024
b95a797
docs(ffe-buttons): info om import av css
antidecaf Nov 19, 2024
aaf368c
docs(ffe-cards): info om import av css
antidecaf Nov 19, 2024
ac99359
docs(ffe-chart-donut-react): info om import av css
antidecaf Nov 19, 2024
2872cb9
docs(ffe-chips): info om import av css
antidecaf Nov 19, 2024
16f3735
docs(ffe-collapse-react): info om import av css
antidecaf Nov 19, 2024
40123ce
docs(ffe-core): info om import av css
antidecaf Nov 19, 2024
0609511
docs(ffe-datepicker): info om import av css
antidecaf Nov 19, 2024
6f5b725
docs(ffe-feedback): info om import av css
antidecaf Nov 19, 2024
be8b40b
docs(ffe-file-upload): info om import av css
antidecaf Nov 19, 2024
3795555
docs(ffe-form): info om import av css
antidecaf Nov 19, 2024
185f5f9
docs(ffe-grid): info om import av css
antidecaf Nov 19, 2024
0c61979
docs(ffe-icons): info om import av css
antidecaf Nov 19, 2024
f71f794
docs(ffe-messages): info om import av css
antidecaf Nov 19, 2024
65f8b4e
docs(ffe-modals): info om import av css
antidecaf Nov 19, 2024
fac97b7
docs(ffe-pagination): info om import av css
antidecaf Nov 19, 2024
e150ac6
docs(ffe-searchable-dropdown-react): info om import av css
antidecaf Nov 19, 2024
9b806a3
docs(ffe-spinner): info om import av css
antidecaf Nov 19, 2024
0b2ef12
docs(ffe-tables): info om import av css
antidecaf Nov 19, 2024
d814e6c
docs(ffe-tabs): info om import av css
antidecaf Nov 19, 2024
651fcc7
fix(ffe-lists): retter filnavn for css og legger til info om import
antidecaf Nov 19, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/ffe-accordion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on accordion usage is available at https://design.sparebank1.
@import 'path/to/node_modules/@sb1/ffe-accordion/less/ffe-accordion';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-accordion/css/ffe-accordion.css';
```

See also `@sb1/ffe-accordion-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-account-selector-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ For styling the account-selector use:
@import 'path/to/node_modules/@sb1/ffe-account-selector-react/less/ffe-account-selector';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-account-selector-react/css/ffe-account-selector.css';
```

## Development

To start a local development server, run the following from the designsystem root folder:
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-buttons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on button usage is available at https://design.sparebank1.no/
@import 'path/to/node_modules/@sb1/ffe-buttons/less/buttons';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-buttons/css/buttons.css';
```

See also `@sb1/ffe-buttons-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-cards/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ Or pick just the ones you need from these:
@import 'path/to/node_modules/@sb1/ffe-cards/less/image-card';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-cards/css/cards.css';
```

See also `@sb1/ffe-cards-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-chart-donut-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Full documentation on chart donut usage is available at https://design.sparebank
@import 'path/to/node_modules/@sb1/ffe-chart-donut-react/less/ffe-chart-donut';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-chart-donut-react/css/ffe-chart-donut.css';
```

## Theming with CSS custom properties

In order to support theming of components, this package contains styling that depends on a set of custom properties, defined in `less/theme.less`. These properties in turn depend on a base theme defined in `ffe-core`.
Expand Down
47 changes: 47 additions & 0 deletions packages/ffe-chips/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# @sb1/ffe-chips

## Install

```bash
npm install --save @sb1/ffe-core @sb1/ffe-chips
```

## Usage

```less
@import 'path/to/node_modules/@sb1/ffe-chips/less/chip';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-chips/css/chip.css';
```

See also `@sb1/ffe-chips-react`.

## Theming with CSS custom properties

In order to support theming of components, this package contains styling that depends on a set of custom properties, defined in `less/theme.less`. These properties in turn depend on a base theme defined in `ffe-core`.

If your project uses the `ffe-core`, you're probably good to go. If not, make sure to import the core properties in `theme.less`:

```css
@import '~@sb1/ffe-core/less/theme';
```

## Development

To start a local development server, run the following from the designsystem root folder:

```bash
npm install
npm run build
npm start
```

A local instance of `component-overview` with live reloading will run at http://localhost:1234/.

Example implementations using the latest versions of all components are also available at https://sparebank1.github.io/designsystem.
8 changes: 8 additions & 0 deletions packages/ffe-collapse-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ Alternatively you can do it by adding style to the class
`.ffe-collapse-transition`\, adding it to your own class and provide the class
through the `className` property or by styling it directly through the `style` property.

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-collapse-react/css/collapse.css';
```

## Development

To start a local development server, run the following from the designsystem root folder:
Expand Down
14 changes: 11 additions & 3 deletions packages/ffe-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ npm install --save-dev less less-plugin-npm-import # less-plugin is optional,

Full documentation on usage is available at:

https://design.sparebank1.no/komponenter/typografi/
https://design.sparebank1.no/profil/farger/
https://design.sparebank1.no/profil/spacing/
* https://design.sparebank1.no/komponenter/typografi/
* https://design.sparebank1.no/profil/farger/
* https://design.sparebank1.no/profil/spacing/

```less
/* Your project's main .less import file */
Expand Down Expand Up @@ -44,6 +44,14 @@ parts you require if you want:
@import '~@sb1/ffe-core/less/accessibility';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-core/css/ffe.css';
```

## Theming with CSS custom properties

Theming of components is supported through a set of custom properties, defined in a `less/theme.less` file in every styling package. The properties in `ffe-core` constitute a base theme, which is in turn used as default values in other packages. You may override the properties in each individual package in order to customize a single component, or override the properties defined in `ffe-core` to customize a sitewide theme.
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-datepicker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ You need styles for both the dateinput field and the calendar.
@import 'node_modules/@sb1/ffe-form/less/form.less';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-datepicker/css/datepicker.css';
```

Example HTML stucture with classes. (Aria-tags and other attributes have been removed for clarity)

```html
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-feedback/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Full documentation is not yet available, but will be added to https://design.spa
@import 'node_modules/@sb1/ffe-feedback/less/feedback';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-feedback/css/feedback.css';
```

See also `@sb1/ffe-feedback-react`.

## Development
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-file-upload/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on file upload usage is available at https://design.sparebank
@import 'path/to/node_modules/@sb1/ffe-file.upload/less/ffe-file-upload.less';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-file-upload/css/file-upload.css';
```

See also `@sb1/ffe-file-upload-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-form/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on form usage is available at https://design.sparebank1.no/ko
@import 'path/to/node_modules/@sb1/ffe-form/less/form';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-form/css/form.css';
```

See also `@sb1/ffe-form-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-grid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Remember to include the less-file in your main less-file:
@import '~@sb1/ffe-grid/less/ffe-grid';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-grid/css/ffe-grid.css';
```

## Usage

Full documentation on grid usage is available at https://design.sparebank1.no/komponenter/grid/.
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-icons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ npm install --save @sb1/ffe-icons

Full documentation on icon usage is available at https://design.sparebank1.no/komponenter/ikoner/.

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-icons/css/ffe-icons.css';
```

See also `@sb1/ffe-icons-react`.

## Updating available icons
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-lists/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on lists usage is available at https://design.sparebank1.no/k
@import 'path/to/node_modules/@sb1/ffe-lists/less/lists';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-lists/css/lists.css';
```

See also `@sb1/ffe-lists-react`.

## Theming with CSS custom properties
Expand Down
2 changes: 1 addition & 1 deletion packages/ffe-lists/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"scripts": {
"lint": "ffe-buildtool stylelint less/*.less",
"test": "npm run lint",
"build": "lessc less/lists.less css/ffe-accordion.css --autoprefix"
"build": "lessc less/lists.less css/lists.css --autoprefix"
},
"dependencies": {
"@sb1/ffe-core": "^29.1.4"
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-messages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on lists usage is available at https://design.sparebank1.no/k
@import 'path/to/node_modules/@sb1/ffe-messages/less/messages';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-messages/css/messages.css';
```

See also `@sb1/ffe-messages-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-modals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on lists usage is available at https://design.sparebank1.no/k
@import 'path/to/node_modules/@sb1/ffe-modals/less/modal';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-modals/css/modal.css';
```

See also `@sb1/ffe-modals-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-pagination/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on lists usage is available at https://design.sparebank1.no/k
@import 'path/to/node_modules/@sb1/ffe-pagination/less/pagination';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-pagination/css/pagination.css';
```

See also `@sb1/ffe-pagination-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-searchable-dropdown-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ styling:
@import "npm://ffe-searchable-dropdown-react/less/searchable-dropdown";
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-searchable-dropdown-react/css/searchable-dropdown.css';
```

## FFE less Dependencies

```
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-spinner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on spinner usage is available at https://design.sparebank1.no
@import 'path/to/node_modules/@sb1/ffe-spinner/less/spinner';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-spinner/css/spinner.css';
```

See also `@sb1/ffe-spinner-react`.

## Development
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-tables/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on table usage is available at https://design.sparebank1.no/k
@import 'path/to/node_modules/@sb1/ffe-tables/less/tables';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-tables/css/tables.css';
```

See also `@sb1/ffe-tables-react`.

## Theming with CSS custom properties
Expand Down
8 changes: 8 additions & 0 deletions packages/ffe-tabs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Full documentation on tabs usage is available at https://design.sparebank1.no/ko
@import 'path/to/node_modules/@sb1/ffe-tabs/less/tabs';
```

### Importing compiled CSS

If your project does not use Less, you can import the compiled styling:

```css
@import '~@sb1/ffe-tabs/css/tabs.css';
```

See also `@sb1/ffe-tabs-react`.

## Theming with CSS custom properties
Expand Down
Loading