mirror of
https://github.com/zoriya/v10.git
synced 2026-08-16 02:45:09 +00:00
feat(site): generated multipart component api reference (#468)
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: FullscreenButton
|
||||
frameworkTitle:
|
||||
html: media-fullscreen-button
|
||||
description: A button component for entering and exiting fullscreen mode
|
||||
---
|
||||
|
||||
import ApiReference from "@/components/docs/api-reference/ApiReference.astro";
|
||||
import FrameworkCase from "@/components/docs/FrameworkCase.astro";
|
||||
|
||||
## Anatomy
|
||||
|
||||
<FrameworkCase frameworks={["react"]}>
|
||||
```tsx
|
||||
<FullscreenButton />
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
<FrameworkCase frameworks={["html"]}>
|
||||
```html
|
||||
<media-fullscreen-button></media-fullscreen-button>
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
<ApiReference component="FullscreenButton" />
|
||||
@@ -1,22 +1,25 @@
|
||||
---
|
||||
title: MuteButton
|
||||
frameworkTitle:
|
||||
html: mute-button
|
||||
html: media-mute-button
|
||||
description: A button component for muting and unmuting audio playback
|
||||
---
|
||||
|
||||
import ApiRefSection from '@/components/docs/api-reference/ApiRefSection.astro';
|
||||
import ApiReference from "@/components/docs/api-reference/ApiReference.astro";
|
||||
import FrameworkCase from "@/components/docs/FrameworkCase.astro";
|
||||
|
||||
## API Reference
|
||||
## Anatomy
|
||||
|
||||
### Props
|
||||
<FrameworkCase frameworks={["react"]}>
|
||||
```tsx
|
||||
<MuteButton />
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
<ApiRefSection component="MuteButton" section="props" />
|
||||
<FrameworkCase frameworks={["html"]}>
|
||||
```html
|
||||
<media-mute-button></media-mute-button>
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
### State
|
||||
|
||||
<ApiRefSection component="MuteButton" section="state" />
|
||||
|
||||
### Data Attributes
|
||||
|
||||
<ApiRefSection component="MuteButton" section="dataAttributes" />
|
||||
<ApiReference component="MuteButton" />
|
||||
|
||||
@@ -1,22 +1,25 @@
|
||||
---
|
||||
title: PlayButton
|
||||
frameworkTitle:
|
||||
html: play-button
|
||||
html: media-play-button
|
||||
description: A button component for playing and pausing media playback
|
||||
---
|
||||
|
||||
import ApiRefSection from '@/components/docs/api-reference/ApiRefSection.astro';
|
||||
import ApiReference from "@/components/docs/api-reference/ApiReference.astro";
|
||||
import FrameworkCase from "@/components/docs/FrameworkCase.astro";
|
||||
|
||||
## API Reference
|
||||
## Anatomy
|
||||
|
||||
### Props
|
||||
<FrameworkCase frameworks={["react"]}>
|
||||
```tsx
|
||||
<PlayButton />
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
<ApiRefSection component="PlayButton" section="props" />
|
||||
<FrameworkCase frameworks={["html"]}>
|
||||
```html
|
||||
<media-play-button></media-play-button>
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
### State
|
||||
|
||||
<ApiRefSection component="PlayButton" section="state" />
|
||||
|
||||
### Data Attributes
|
||||
|
||||
<ApiRefSection component="PlayButton" section="dataAttributes" />
|
||||
<ApiReference component="PlayButton" />
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: Time
|
||||
frameworkTitle:
|
||||
html: media-time
|
||||
description: Components for displaying and composing media time information
|
||||
---
|
||||
|
||||
import ApiReference from "@/components/docs/api-reference/ApiReference.astro";
|
||||
import FrameworkCase from "@/components/docs/FrameworkCase.astro";
|
||||
|
||||
## Anatomy
|
||||
|
||||
<FrameworkCase frameworks={["react"]}>
|
||||
```tsx
|
||||
<Time.Group>
|
||||
<Time.Value type="current" />
|
||||
<Time.Separator />
|
||||
<Time.Value type="duration" />
|
||||
</Time.Group>
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
<FrameworkCase frameworks={["html"]}>
|
||||
```html
|
||||
<media-time-group>
|
||||
<media-time type="current"></media-time>
|
||||
<media-time-separator></media-time-separator>
|
||||
<media-time type="duration"></media-time>
|
||||
</media-time-group>
|
||||
```
|
||||
</FrameworkCase>
|
||||
|
||||
<ApiReference component="Time" />
|
||||
Reference in New Issue
Block a user