Skip to content

Commit

Permalink
docs: update get-started (#699)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlmoravek committed Dec 21, 2023
1 parent 13d27de commit a6aac89
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions packages/docs-next/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ In addition, if you don't want to style everything yourself, we've created sever
--- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |

> IE is not supported.
💅 For more info about components customisation, go to [#customisation](/documentation/customisation).

🕹 To see Oruga in action, go to [#examples](#examples).
Expand All @@ -43,6 +45,12 @@ yarn add @oruga-ui/oruga-next

:::

::: warning _Oruga for Vue 2.x deprecated_
Due to [EOL for Vue 2.x](https://v2.vuejs.org/lts/) at the end of the year 2023, from now on Oruga for Vue 2 ([`@oruga-ui/oruga`](https://www.npmjs.com/package/@oruga-ui/oruga)) is deprecated.
Further enhancements will only be developed for [`@oruga-ui/oruga-next`](https://www.npmjs.com/package/@oruga-ui/oruga-next).
:::


### Full bundle import

You can import all Oruga components using the main plugin export:
Expand All @@ -54,6 +62,14 @@ import Oruga from '@oruga-ui/oruga-next';
createApp(...).use(Oruga);
```

After the installation, you can use all the components in your SFC like this.

```html
<template>
<o-button>oruga-ui</o-button>
</template>
```

### Individual components imports (tree shaking)

Each component can also be added individually using its own plugin. This adds the component, including its subcomponents and programmatic components:
Expand Down

0 comments on commit a6aac89

Please sign in to comment.