Skip to content

Commit

Permalink
docs: update labs component descriptions and minimum versions
Browse files Browse the repository at this point in the history
  • Loading branch information
johnleider committed Feb 29, 2024
1 parent b9047e7 commit cfd92c1
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 8 deletions.
16 changes: 8 additions & 8 deletions packages/docs/src/pages/en/components/calendars.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@ The `v-calendar` component is used to display information in a daily, weekly, mo
This feature requires [v3.4.9](/getting-started/release-notes/?version=v3.4.9)
:::

## Usage

A calendar has a type and a value which determines what type of calendar is shown over what span of time. This shows the bare minimum configuration, an array of events with **title**, **start** and **end** properties. **end** is optional, it defaults to the **start**. If the **start** has a time it's considered a timed event and will be shown accordingly in the day views. An event can span multiple days and will be rendered accordingly.

<ExamplesExample file="v-calendar/usage" />

<PromotedEntry />

## Installation

Labs components require a manual import and installation of the component.
Expand All @@ -47,6 +39,14 @@ export default createVuetify({
})
```

## Usage

A calendar has a type and a value which determines what type of calendar is shown over what span of time. This shows the bare minimum configuration, an array of events with **title**, **start** and **end** properties. **end** is optional, it defaults to the **start**. If the **start** has a time it's considered a timed event and will be shown accordingly in the day views. An event can span multiple days and will be rendered accordingly.

<ExamplesExample file="v-calendar/usage" />

<PromotedEntry />

## API

| Component | Description |
Expand Down
10 changes: 10 additions & 0 deletions packages/docs/src/pages/en/components/empty-states.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ The `v-empty-state` component is used to indicate that a list is empty or that n

<PageFeatures />

::: warning

This feature requires [v3.5.6](/getting-started/release-notes/?version=v3.5.6)

:::

## Installation

Labs components require a manual import and installation of the component.

```js { resource="src/plugins/vuetify.js" }
import { VEmptyState } from 'vuetify/labs/VEmptyState'

Expand Down
6 changes: 6 additions & 0 deletions packages/docs/src/pages/en/components/sparklines.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ The sparkline component can be used to create simple graphs, like GitHub's contr

<PromotedEntry />

::: warning

This feature requires [v3.5.5](/getting-started/release-notes/?version=v3.5.5)

:::

## Installation

Labs components require a manual import and installation of the component.
Expand Down
1 change: 1 addition & 0 deletions packages/docs/src/pages/en/labs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ The following is a list of available and up-and-coming components for use with L
| Component | Description | Min Version |
| - | - | - |
| [v-calendar](/components/calendars/) | A calendar component | [v3.4.9](/getting-started/release-notes/?version=v3.4.9) |
| [v-empty-state](/components/empty-states/) | A component for displaying empty states | [v3.5.6](/getting-started/release-notes/?version=v3.5.6) |
| [v-sparkline](/components/sparklines/) | A basic data display component | [v3.5.5](/getting-started/release-notes/?version=v3.5.5) |

::: warning
Expand Down

2 comments on commit cfd92c1

@1Luc1
Copy link

@1Luc1 1Luc1 commented on cfd92c1 Feb 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@johnleider shouldn't it be v3.5.7 ?

@johnleider
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@johnleider shouldn't it be v3.5.7 ?

How dare you look at my public commits and point out mistakes! 1974b8d

Please sign in to comment.