Skip to main content

examples

Named exports​

  • Examples: The design constructor
  • about: Metadata about the design
  • i18n: Internationalisation (i18n/translation) data for the design
  • rect1: The rect1 part of the design
  • rect2: The rect2 part of the design
  • rect3: The rect3 part of the design
  • rectBase: The rectBase part of the design
  • stacks_bottom: The stacks_bottom part of the design
  • stacks_left: The stacks_left part of the design
  • stacks_leftEye: The stacks_leftEye part of the design
  • stacks_mouth: The stacks_mouth part of the design
  • stacks_right: The stacks_right part of the design
  • stacks_rightEye: The stacks_rightEye part of the design
  • stacks_top: The stacks_top part of the design

Constructor​

To create a new examples Design, import the constructur as such:

import { Examples } from '@freesewing/examples'

Then you can instantiate it by passing a settings object:

const pattern = new Examples(settings)

Design config​

You can access the design configuration without instantiating a design. It is available as the designConfig property of the design constructor:

import { Examples } from '@freesewing/examples'

// Access the design config from the constructor
const dConf = Examples.designConfig

Pattern config​

You can access the pattern configuration without instantiating a design. It is available as the patternConfig property of the design constructor:

import { Examples } from '@freesewing/examples'

// Access the pattern config from the constructor
const pConf = Examples.patternConfig

Metadata​

You can access the design's metadata through the about named export:

import { about } from '@freesewing/examples'

I18n​

You can access the design's internationalization data through the i18n named export:

import { i18n } from '@freesewing/examples'

Parts​

rect1​

The part itself​

You can access this part as the rect1 named export:

import { rect1 } from '@freesewing/examples'

Part store reads​

This part reads the following values from the store:

  • width
  • height
  • cutlist
  • title

This means that this part relies on these values being available in the store prior to the part being drafted.

rect2​

The part itself​

You can access this part as the rect2 named export:

import { rect2 } from '@freesewing/examples'

Part store reads​

This part reads the following values from the store:

  • width
  • height
  • cutlist
  • title

This means that this part relies on these values being available in the store prior to the part being drafted.

rect3​

The part itself​

You can access this part as the rect3 named export:

import { rect3 } from '@freesewing/examples'

Part store reads​

This part reads the following values from the store:

  • width
  • height
  • cutlist
  • title

This means that this part relies on these values being available in the store prior to the part being drafted.

rectBase​

The part itself​

You can access this part as the rectBase named export:

import { rectBase } from '@freesewing/examples'

stacks_bottom​

The part itself​

You can access this part as the stacks_bottom named export:

import { stacks_bottom } from '@freesewing/examples'

stacks_left​

The part itself​

You can access this part as the stacks_left named export:

import { stacks_left } from '@freesewing/examples'

stacks_leftEye​

The part itself​

You can access this part as the stacks_leftEye named export:

import { stacks_leftEye } from '@freesewing/examples'

stacks_mouth​

The part itself​

You can access this part as the stacks_mouth named export:

import { stacks_mouth } from '@freesewing/examples'

stacks_right​

The part itself​

You can access this part as the stacks_right named export:

import { stacks_right } from '@freesewing/examples'

stacks_rightEye​

The part itself​

You can access this part as the stacks_rightEye named export:

import { stacks_rightEye } from '@freesewing/examples'

stacks_top​

The part itself​

You can access this part as the stacks_top named export:

import { stacks_top } from '@freesewing/examples'