[react] feat: Added docs for components/Xray
This commit is contained in:
parent
5e5d3a0270
commit
0a345b3347
5 changed files with 64 additions and 7 deletions
|
@ -0,0 +1,10 @@
|
|||
import React from 'react'
|
||||
import { MiniNote } from '@freesewing/react/components/Mini'
|
||||
|
||||
export const Example = () => (
|
||||
<MiniNote>
|
||||
Components in the Xray family are tightly coupled with FreeSewing pattern structure.
|
||||
Stand-alone examples are not provided as they are not very relevant.
|
||||
</MiniNote>
|
||||
)
|
||||
|
|
@ -2,6 +2,36 @@
|
|||
title: Xray
|
||||
---
|
||||
|
||||
:::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 { ConstantDocs } from '@site/src/components/constant-docs.js'
|
||||
import * as jsdoc from '@site/prebuild/jsdoc/components.xray.mjs'
|
||||
import * as cdoc from '@site/prebuild/jsdoc/constants.xray.mjs'
|
||||
import { Example } from './_examples.js'
|
||||
|
||||
<DocusaurusDoc>
|
||||
|
||||
- [Components](#components)
|
||||
- [Constants](#constants)
|
||||
|
||||
## Components
|
||||
|
||||
The **Xray** component family provides the following components:
|
||||
|
||||
- [Xray](#json)
|
||||
|
||||
### Xray
|
||||
|
||||
<ComponentDocs docs={jsdoc.jsdocXray} example={Example} />
|
||||
|
||||
## Constants
|
||||
|
||||
The **Xray** family exports the following constants:
|
||||
|
||||
- [defaultComponents](defaultcomponents)
|
||||
|
||||
### defaultComponents
|
||||
|
||||
<ConstantDocs docs={cdoc.jsdocdefaultComponents} />
|
||||
|
||||
</DocusaurusDoc>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue