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.

Sign up for GitHub

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

Jump to bottom

docs: update get-started #699

Merged
merged 1 commit into from
Dec 21, 2023
Merged

docs: update get-started #699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions packages/docs-next/documentation/index.md
View file
Open in desktop
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
Loading