1
0
Fork 0

[react] feat: Added docs for components/Mini

This commit is contained in:
joostdecock 2025-05-24 18:03:59 +02:00
parent 17619aebcb
commit 7317ff5dd8
4 changed files with 66 additions and 2 deletions

View file

@ -0,0 +1,6 @@
import React from 'react'
import { MiniNote, MiniTip, MiniWarning } from '@freesewing/react/components/Mini'
export const MiniNoteExample = () => <MiniNote>I am a note, a mini note</MiniNote>
export const MiniTipExample = () => <MiniTip>I am a tip, a mini tip</MiniTip>
export const MiniWarningExample = () => <MiniWarning>I am a warning, a mini warning</MiniWarning>

View file

@ -2,6 +2,39 @@
title: Mini
---
:::note
This page is yet to be created
import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus'
import { ComponentDocs } from '@site/src/components/component-docs.js'
import * as jsdoc from '@site/prebuild/jsdoc/components.mini.mjs'
import {
MiniNoteExample,
MiniTipExample,
MiniWarningExample,
} from './_examples.js'
<DocusaurusDoc>
The __Mini__ component family provides the following components:
- [MiniNote](#mininote)
- [MiniTip](#minitip)
- [MiniWarning](#miniwarning)
:::tip
These components are typically used when a
[Popout](/reference/packages/react/components/popout/) would take up too much
space.
:::
## MiniNote
<ComponentDocs docs={jsdoc.jsdocMiniNote} example={MiniNoteExample} />
## MiniTip
<ComponentDocs docs={jsdoc.jsdocMiniTip} example={MiniTipExample} />
## MiniWarning
<ComponentDocs docs={jsdoc.jsdocMiniWarning} example={MiniWarningExample} />
</DocusaurusDoc>