Skip to content

Commit cc41439

Browse files
committed
docs: add callouts for usability
1 parent ab79b08 commit cc41439

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/content/1.getting-started/2.usage.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -466,13 +466,21 @@ import '@directus/vue-split-panel/index.css';
466466
</script>
467467
468468
<template>
469-
<SplitPanel primary="start">
469+
<SplitPanel primary="start" class="h-128">
470470
<template #start>
471-
<div class="w-full bg-orange-50 flex items-center justify-center">Panel A</div>
471+
<div class="w-full h-full bg-orange-50 flex items-center justify-center">Panel A</div>
472472
</template>
473473
474474
<template #end>
475-
<div class="w-full h-full bg-blue-50 flex items-center justify-center">Panel B</div>
475+
<SplitPanel orientation="vertical">
476+
<template #start>
477+
<div class="w-full h-full bg-red-50 flex items-center justify-center">Panel B</div>
478+
</template>
479+
480+
<template #end>
481+
<div class="w-full h-full bg-green-50 flex items-center justify-center">Panel C</div>
482+
</template>
483+
</SplitPanel>
476484
</template>
477485
</SplitPanel>
478486
</template>
@@ -487,7 +495,7 @@ By setting `primary` to either `start` or `end`, you can make sure that the prim
487495

488496
:::split-panel
489497
---
490-
class: w-full resize-x
498+
class: w-full
491499
primary: start
492500
size: 350
493501
size-unit: px
@@ -525,6 +533,10 @@ import '@directus/vue-split-panel/index.css';
525533

526534
::
527535

536+
::callout{icon="i-lucide-info" color="primary"}
537+
Resize your browser window to see primary in action.
538+
::
539+
528540
## Accessibility
529541

530542
Uses the [Window Splitter WAI-ARIA pattern](https://www.w3.org/WAI/ARIA/apg/patterns/windowsplitter).
@@ -540,3 +552,7 @@ Uses the [Window Splitter WAI-ARIA pattern](https://www.w3.org/WAI/ARIA/apg/patt
540552
| :kbd{value="ArrowLeft"} | Moves a vertical splitter left |
541553
| :kbd{value="Home"} | Moves the splitter to the configured min-size |
542554
| :kbd{value="End"} | Moves the splitter to the configured max-size |
555+
556+
::callout{icon="i-lucide-person-standing" color="warning"}
557+
The divider by default has no styling. Please add your own divider element to handle focus styles.
558+
::

0 commit comments

Comments
 (0)