Skip to content

Commit 3f874c5

Browse files
committed
Begin to hide examples and replace with explicit usage and docs
1 parent 8b184cf commit 3f874c5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+294
-87
lines changed

docs/src/content/components/AnnotationLine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ related: [AnnotationPoint, AnnotationRange]
99
import Example from '$lib/components/Example.svelte';
1010
</script>
1111

12-
## Examples
12+
<!-- ## Examples
1313
1414
### Vertical
1515
@@ -41,4 +41,4 @@ related: [AnnotationPoint, AnnotationRange]
4141
4242
### Bar chart
4343
44-
<Example name="bar-chart" />
44+
<Example name="bar-chart" /> -->

docs/src/content/components/AnnotationPoint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ related: [AnnotationLine, AnnotationRange]
99
import Example from '$lib/components/Example.svelte';
1010
</script>
1111

12-
## Examples
12+
<!-- ## Examples
1313
1414
### On axis with tooltip
1515
@@ -37,4 +37,4 @@ related: [AnnotationLine, AnnotationRange]
3737
3838
### Band scale on value
3939
40-
<Example name="band-scale-on-value" />
40+
<Example name="band-scale-on-value" /> -->

docs/src/content/components/AnnotationRange.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ related: [AnnotationLine, AnnotationPoint]
99
import Example from '$lib/components/Example.svelte';
1010
</script>
1111

12-
## Examples
12+
<!-- ## Examples
1313
1414
### Horizontal with pattern, lower bound
1515
@@ -61,4 +61,4 @@ related: [AnnotationLine, AnnotationPoint]
6161
6262
### Hide tooltip
6363
64-
<Example name="hide-tooltip" />
64+
<Example name="hide-tooltip" /> -->

docs/src/content/components/Arc.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,18 @@ related: [Pie, ArcChart, PieChart]
1111

1212
> See also: [ArcChart](/docs/components/ArcChart) and [PieChart](/docs/components/PieChart) for simplified examples
1313
14-
## Examples
14+
## Usage
1515

16-
### Playground
16+
<Example name="partial-arc" showCode />
1717

18-
<Example name="playground" />
18+
## Text along path
19+
20+
`Arc` can be used with the `children` snippet, `getArcTextProps`, and `Text` to write text along the `inner`, `outer`, or `middle` of the arc path.
1921

20-
### Label direction
22+
The text will smartly orientate based on the direction (clockwise / counter-clockwise) and location (top, bottom, left, right) of the arc
2123

2224
<Example name="label-direction" />
25+
26+
## Playground
27+
28+
<Example name="playground" />

docs/src/content/components/ArcChart.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ related: [Chart, Pie]
99
import Example from '$lib/components/Example.svelte';
1010
</script>
1111

12-
## Examples
12+
## Usage
13+
14+
<Example name="basic" showCode />
15+
16+
<!-- ## Examples
1317
1418
### Basic
1519
@@ -79,4 +83,4 @@ related: [Chart, Pie]
7983
8084
### Motion (spring)
8185
82-
<Example name="series-motion-spring" />
86+
<Example name="series-motion-spring" /> -->

docs/src/content/components/Area.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ related: []
1111

1212
> See also: [AreaChart](/docs/components/AreaChart) for simplified examples
1313
14+
## Usage
15+
16+
<Example name="basic" showCode />
17+
1418
## Playground
1519

1620
<Example name="playground" />

docs/src/content/components/AreaChart.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ related: [Chart, Area]
99
import Example from '$lib/components/Example.svelte';
1010
</script>
1111

12-
## Examples
12+
## Usage
13+
14+
<Example name="basic" showCode />
15+
16+
<!-- ## Examples
1317
1418
### Basic
1519
@@ -173,4 +177,4 @@ related: [Chart, Area]
173177
174178
### Custom
175179
176-
<Example name="custom" />
180+
<Example name="custom" /> -->

docs/src/content/components/Axis.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ related: [Grid, Rule]
99
import Example from '$lib/components/Example.svelte';
1010
</script>
1111

12-
## Examples
12+
## Usage
13+
14+
<Example name="placement-bottom-left" showCode />
15+
16+
<!-- ## Examples
1317
1418
### Placement (bottom / left)
1519
@@ -181,4 +185,4 @@ Specify explicit time intervals such as every day, every 6 months, etc with comp
181185
182186
### Time scale (brush) with multiline ticks
183187
184-
<Example name="time-scale-brush-multiline" />
188+
<Example name="time-scale-brush-multiline" /> -->

docs/src/content/components/Bar.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,9 @@ related: [Bars]
88
<script lang="ts">
99
import Example from '$lib/components/Example.svelte';
1010
</script>
11+
12+
## Usage
13+
14+
<Example component="Bars" name="vertical-customize-individual-styles" showCode />
15+
16+
Typically the component is rendering within the `Bars` mark but can be rendered explicitly when you need more control on a per-mark basis

docs/src/content/components/BarChart.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ related: [Chart, Bars]
99
import Example from '$lib/components/Example.svelte';
1010
</script>
1111

12-
## Examples
12+
## Usage
13+
14+
<Example name="vertical-default" showCode />
15+
16+
<!-- ## Examples
1317
1418
### Vertical (default)
1519
@@ -261,4 +265,4 @@ related: [Chart, Bars]
261265
262266
### Custom chart
263267
264-
<Example name="custom-chart" />
268+
<Example name="custom-chart" /> -->

0 commit comments

Comments
 (0)