From 5e230b163aea80a2daed224103dc9130e0218599 Mon Sep 17 00:00:00 2001 From: mlmo Date: Thu, 21 Dec 2023 14:55:11 +0100 Subject: [PATCH] docs: update get-started --- packages/docs-next/documentation/index.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/packages/docs-next/documentation/index.md b/packages/docs-next/documentation/index.md index 5661a6190..777af21d4 100644 --- a/packages/docs-next/documentation/index.md +++ b/packages/docs-next/documentation/index.md @@ -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). @@ -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: @@ -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 + +``` + ### 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: