Skip to content

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joao-m-santos committed Sep 26, 2023
1 parent 99850a7 commit d7cbdca
Showing 1 changed file with 81 additions and 0 deletions.
81 changes: 81 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,87 @@ Vue.use(LumePlugin);
const app = new Vue(App).$mount('#root');
```

### Styles

For Lume to render as intended, you also need to import its styles.

#### CSS (global)

```ts
// app/index/main.ts
import Vue from 'vue';
import App from './my-app.vue';

// Main styles
import '@adyen/lume/styles';
// (Optional) Lume font
import '@adyen/lume/font';

const app = new Vue(App).$mount('#root');
```

#### Sass (global)

```ts
// app/index/main.ts
import Vue from 'vue';
import App from './my-app.vue';

// Main styles
import '@adyen/lume/scss';
// (Optional) Lume font
import '@adyen/lume/font';

const app = new Vue(App).$mount('#root');
```

#### CSS (SFC)

```vue
<template>...</template>
<script>
...
</script>
<!-- Main styles -->
<style src="@adyen/lume/styles"></style>
<!-- (Optional) Lume font -->
<style src="@adyen/lume/font"></style>
```

#### Sass (SFC)

```vue
<template>...</template>
<script>
...
</script>
<!-- Main styles -->
<style lang="scss" src="@adyen/lume/scss"></style>
<!-- (Optional) Lume font -->
<style src="@adyen/lume/font"></style>
```

#### Sass (with overrides)

```vue
<template>...</template>
<script>
...
</script>
<!-- Main styles -->
<style lang="scss">
@use '@adyen/lume/scss' with (
$lume-font-family: 'Times New Roman'
);
</style>
```

## Development

You can clone this repo and use `pnpm` to install dependencies. We use Storybook to develop our features.
Expand Down

0 comments on commit d7cbdca

Please sign in to comment.