1
0
Fork 0
freesewing/sites/dev/docs/reference/api/part/config/options/bool
Joost De Cock ab3204f9f1 chore: Port FreeSewing.dev to docusaurus
The replaces the NextJS site powering FreeSewing.dev with a Docusaurus
setup. It's part of my efforts to simplify FreeSewing's setup so we can
focus on our core value proposition.
2024-09-28 13:13:48 +02:00
..
readme.mdx chore: Port FreeSewing.dev to docusaurus 2024-09-28 13:13:48 +02:00

---
title: Boolean options
---

For options where the choice is either `true` or `false`, **on** or **off**,
or **yes** or **no**, use a boolean option.

## Structure

A boolean option is a plain object with these properties:

- `bool` : Either `true` or `false` which will be the default

:::tip

Like all options that are configured through an object, you can 
add more properties to the options' object to implement functionality on
top of what's provided by the core library.

Refer to [extending options](/reference/api/part/config/options/extend) for
more details.

:::

## Example

```js
const part = {
  name: 'example.front',
  options: {
    withLining: { 
      bool: true 
    }
  },
  draft: ({ part }) => part
}
```