VSinerva/freesewing
1
0
Fork 0
Code Activity

feat: Added package documentation (wip)

Browse source
This commit is contained in:
joostdecock 2025-04-18 19:19:20 +02:00
parent f734707163
commit 02da928f04
82 changed files with 2248 additions and 466 deletions
Download patch file Download diff file Expand all files Collapse all files

7
sites/dev/docs/reference/packages/react/components/account/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Account
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/admin/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Admin
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/breadcrumbs/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Breadcrumbs
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/button/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Button
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/collection/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Collection
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/control/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Control
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/copytoclipboardbutton/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: CopyToClipboardButton
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/curatedset/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: CuratedSet
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/design/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Design
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/diffviewer/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: DiffViewer
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/docusaurus/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Docusaurus
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/echart/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Echart
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/editor/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Editor
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/heading/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Heading
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/highlight/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Highlight
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/icon/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Icon
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/input/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Input
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/json/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Json
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/keyval/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: KeyVal
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/layout/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Layout
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/linedrawing/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Linedrawing
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/link/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Link
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/logo/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Logo
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/markdown/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Markdown
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/mini/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Mini
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/modal/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Modal
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/new/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: New
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/newsletter/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Newsletter
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/null/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: 'Null'
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/number/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Number
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/patrons/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Patrons
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/pattern/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Pattern
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/popout/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Popout
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/profile/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Profile
---
:::note
This page is yet to be created
:::

74
sites/dev/docs/reference/packages/react/components/readme.mdx Normal file
View file

@ -0,0 +1,74 @@
---
title: React Components
---
The React components provided by the
[@freesewing/react](/reference/packages/react/) package are grouped by
_component family_.
For each family, the import structure is the same:
```js
import { Component } from '@freesewing/react/components/Family'
```
Click on any component family to see which components they provide:
<ReadMore />
- [components/Account](/reference/packages/react/components/account/)
- [components/Admin](/reference/packages/react/components/admin/)
- [components/Breadcrumbs](/reference/packages/react/components/breadcrumbs/)
- [components/Button](/reference/packages/react/components/button/)
- [components/Collection](/reference/packages/react/components/collection/)
- [components/Control](/reference/packages/react/components/control/)
- [components/CopyToClipboardButton](/reference/packages/react/components/copytoclipboardbutton/)
- [components/CuratedSet](/reference/packages/react/components/curatedset/)
- [components/Design](/reference/packages/react/components/design/)
- [components/DiffViewer](/reference/packages/react/components/diffviewer/)
- [components/Docusaurus](/reference/packages/react/components/docusaurus/)
- [components/Echart](/reference/packages/react/components/echart/)
- [components/Editor](/reference/packages/react/components/editor/)
- [components/Heading](/reference/packages/react/components/heading/)
- [components/Highlight](/reference/packages/react/components/highlight/)
- [components/Icon](/reference/packages/react/components/icon/)
- [components/Input](/reference/packages/react/components/input/)
- [components/Json](/reference/packages/react/components/json/)
- [components/KeyVal](/reference/packages/react/components/keyval/)
- [components/Layout](/reference/packages/react/components/layout/)
- [components/LineDrawing](/reference/packages/react/components/linedrawing/)
- [components/Link](/reference/packages/react/components/link/)
- [components/Logo](/reference/packages/react/components/logo/)
- [components/Markdown](/reference/packages/react/components/markdown/)
- [components/Mini](/reference/packages/react/components/mini/)
- [components/Modal](/reference/packages/react/components/modal/)
- [components/New](/reference/packages/react/components/new/)
- [components/Newsletter](/reference/packages/react/components/newsletter/)
- [components/Null](/reference/packages/react/components/null/)
- [components/Number](/reference/packages/react/components/number/)
- [components/Pattern](/reference/packages/react/components/pattern/)
- [components/Patrons](/reference/packages/react/components/patrons/)
- [components/Popout](/reference/packages/react/components/popout/)
- [components/Profile](/reference/packages/react/components/profile/)
- [components/Role](/reference/packages/react/components/role/)
- [components/SignIn](/reference/packages/react/components/signin/)
- [components/SignUp](/reference/packages/react/components/signup/)
- [components/Spinner](/reference/packages/react/components/spinner/)
- [components/Stats](/reference/packages/react/components/stats/)
- [components/Tab](/reference/packages/react/components/tab/)
- [components/Table](/reference/packages/react/components/table/)
- [components/Time](/reference/packages/react/components/time/)
- [components/Uuid](/reference/packages/react/components/uuid/)
- [components/Ux](/reference/packages/react/components/ux/)
- [components/Yaml](/reference/packages/react/components/yaml/)
- [components/Xray](/reference/packages/react/components/xray/)
## Context
- context/LoadingStatus](/reference/packages/react": "./context/LoadingStatus/index.mjs",
## Names exports
- linedrawings](/reference/packages/react": "./src/linedrawings/index.mjs",
- pattern](/reference/packages/react": "./src/pattern/index.mjs",
- xray](/reference/packages/react": "./src/pattern-xray/index.mjs",

7
sites/dev/docs/reference/packages/react/components/role/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Role
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/signin/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: SignIn
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/signup/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: SignUp
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/spinner/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Spinner
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/stats/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Stats
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/tab/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Tab
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/table/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Table
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/time/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Time
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/uuid/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Uuid
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/ux/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Ux
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/xray/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Xray
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/components/yaml/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: Yaml
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/context/loadingstatus/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: LoadingStatusContext
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/context/modal/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: ModalContext
---
:::note
This page is yet to be created
:::

8
sites/dev/docs/reference/packages/react/context/readme.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: React Context
---
The React context provided by the
[@freesewing/react](/reference/packages/react/) package are:
<ReadMore />

8
sites/dev/docs/reference/packages/react/hooks/readme.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: React Hooks
---
The React hooks provided by the
[@freesewing/react](/reference/packages/react/) package are:
<ReadMore />

7
sites/dev/docs/reference/packages/react/hooks/useaccount/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: useAccount
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/hooks/usebackend/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: useBackend
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/hooks/usecontrol/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: useControl
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/hooks/usedesign/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: useDesign
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/hooks/usedesigntranslation/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: useDesignTranslation
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/hooks/useselection/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: useSelection
---
:::note
This page is yet to be created
:::

7
sites/dev/docs/reference/packages/react/hooks/usestateobject/readme.mdx Normal file
View file

@ -0,0 +1,7 @@
---
title: useStateObject
---
:::note
This page is yet to be created
:::

8
sites/dev/docs/reference/packages/react/lib/readme.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: React Library
---
The utility methods provided by the
[@freesewing/react](/reference/packages/react/) package are:
<ReadMore />

38
sites/dev/docs/reference/packages/react/readme.mdx Normal file
View file

@ -0,0 +1,38 @@
---
title: '@freesewing/react'
---
FreeSewing's **react** package bundles React components, hooks, and context
used to build the FreeSewing frontends.
It is published on NPM as [@freesewing/react
](https://www.npmjs.com/package/@freesewing/react).\
The source code for this package is available in [our monorepo on Codeberg
](https://codeberg.org/freesewing/freesewing) under [packages/react
](https://codeberg.org/freesewing/freesewing/src/branch/develop/packages/react).
:::warning INTERNAL TO FREESEWING
This package is considered internal to FreeSewing.\
You are free to use this package, but FreeSewing does not guarantee semantic versioning
on this package.
In other words, FreeSewing may introduce breaking changes in minor or even
patch updates of this package.
:::
:::note
This package does not provide a default export.
:::
## Installation
```sh
npm install --save @freesewing/react
```
## Named Exports
As this is a rather large package, documentation of the things it provides are
split up over various sections:
<ReadMore />