VSinerva/freesewing
1
0
Fork 0
Code Activity

feat(dev): Added react docs for Pattern + refactor

Browse source 
This adds support for not only documenating components, but also
constants and functions that may be exported next to components.
This commit is contained in:
joostdecock 2025-05-25 16:29:57 +02:00
parent d0baf7cece
commit 22a89f12d3
50 changed files with 1816 additions and 669 deletions
Download patch file Download diff file Expand all files Collapse all files

28
packages/react/components/Pattern/part.mjs
View file

@ -2,6 +2,20 @@
import React, { forwardRef } from 'react'
import { getId, getProps } from './utils.mjs'
/**
* A component to render an inner FreeSewing Part in a pattern (no group)
*
* @component
* @param {object} props - All component props
* @param {string} props.stackName - The name of the stack the part belongs to
* @param {string} props.partName - The name of the part
* @param {object} props.part - The part object itself
* @param {object} props.settings - The pattern settings object
* @param {object} props.components - An object holding the pattern compnents to use
* @param {object} props.strings - An object holding translations
* @param {object} props.drillProps - An object holding extra props to pass down (used in Xray mode)
* @returns {JSX.Element}
*/
export const PartInner = forwardRef(
({ stackName, partName, part, settings, components, strings, drillProps }, ref) => {
const { Group, Path, Point, Snippet } = components
@ -50,6 +64,20 @@ export const PartInner = forwardRef(
PartInner.displayName = 'PartInner'
/**
* A component to render a FreeSewing Part (group) in a pattern
*
* @component
* @param {object} props - All component props
* @param {string} props.stackName - The name of the stack the part belongs to
* @param {string} props.partName - The name of the part
* @param {object} props.part - The part object itself
* @param {object} props.settings - The pattern settings object
* @param {object} props.components - An object holding the pattern compnents to use
* @param {object} props.strings - An object holding translations
* @param {object} props.drillProps - An object holding extra props to pass down (used in Xray mode)
* @returns {JSX.Element}
*/
export const Part = ({ stackName, partName, part, settings, components, strings, drillProps }) => {
const { Group } = components