Skip to main content

onyx

note

This design is part of the FreeSewing collection

Named exports​

  • Onyx: The design constructor
  • about: Metadata about the design
  • back: The back part of the design
  • crotchGusset: The crotchGusset part of the design
  • front: The front part of the design
  • hood: The hood part of the design
  • hoodFront: The hoodFront part of the design
  • i18n: Internationalisation (i18n/translation) data for the design
  • legRibbing: The legRibbing part of the design
  • neckband: The neckband part of the design
  • raglanSleeve: The raglanSleeve part of the design
  • skirt: The skirt part of the design
  • sleeveRibbing: The sleeveRibbing part of the design
  • zipperGuard: The zipperGuard part of the design

Constructor​

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

import { Onyx } from '@freesewing/onyx'

Then you can instantiate it by passing a settings object:

const pattern = new Onyx(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 { Onyx } from '@freesewing/onyx'

// Access the design config from the constructor
const dConf = Onyx.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 { Onyx } from '@freesewing/onyx'

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

Metadata​

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

import { about } from '@freesewing/onyx'

I18n​

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

import { i18n } from '@freesewing/onyx'

Parts​

back​

The part itself​

You can access this part as the back named export:

import { back } from '@freesewing/onyx'

crotchGusset​

The part itself​

You can access this part as the crotchGusset named export:

import { crotchGusset } from '@freesewing/onyx'

front​

The part itself​

You can access this part as the front named export:

import { front } from '@freesewing/onyx'

hood​

The part itself​

You can access this part as the hood named export:

import { hood } from '@freesewing/onyx'

hoodFront​

The part itself​

You can access this part as the hoodFront named export:

import { hoodFront } from '@freesewing/onyx'

legRibbing​

The part itself​

You can access this part as the legRibbing named export:

import { legRibbing } from '@freesewing/onyx'

neckband​

The part itself​

You can access this part as the neckband named export:

import { neckband } from '@freesewing/onyx'

raglanSleeve​

The part itself​

You can access this part as the raglanSleeve named export:

import { raglanSleeve } from '@freesewing/onyx'

skirt​

The part itself​

You can access this part as the skirt named export:

import { skirt } from '@freesewing/onyx'

sleeveRibbing​

The part itself​

You can access this part as the sleeveRibbing named export:

import { sleeveRibbing } from '@freesewing/onyx'

zipperGuard​

The part itself​

You can access this part as the zipperGuard named export:

import { zipperGuard } from '@freesewing/onyx'