EnumStyleProp • tldraw Docs

Table of contents

defaultValue
id
type
values
Properties
Methods

Extends StyleProp<T>.

class EnumStyleProp<T> extends StyleProp<T> {}

Properties

defaultValue

from StyleProp

defaultValue: Type;

id

readonly

from StyleProp

readonly id: string;

type

readonly

from StyleProp

readonly type: T.Validatable<Type>;

values

readonly

readonly values: T[];

Methods

define( )

static

from StyleProp

Define a new StyleProp.

static define<Type>(
  uniqueId: string,
  options: {
    defaultValue: Type;
    type?: T.Validatable<Type>;
  },
): StyleProp<Type>;

Example

import { T } from "@tldraw/validate";
import { StyleProp } from "@tldraw/tlschema";

const MyLineWidthProp = StyleProp.define("myApp:lineWidth", {
  defaultValue: 1,
  type: T.number,
});

Parameters

Name	Description
`uniqueId`	`string;` Each StyleProp must have a unique ID. We recommend you prefix this with your app/library name.
`options`	`{ defaultValue: Type; type?: T.Validatable<Type>; };` `defaultValue`: The default value for this style prop. `type`: Optionally, describe what type of data you expect for this style prop.

Returns

StyleProp<Type>;

defineEnum( )

static

from StyleProp

Define a new StyleProp as a list of possible values.

static defineEnum<const Values extends readonly unknown[]>(
  uniqueId: string,
  options: {
    defaultValue: Values[number];
    values: Values;
  },
): EnumStyleProp<Values[number]>;

Example

import { StyleProp } from "@tldraw/tlschema";

const MySizeProp = StyleProp.defineEnum("myApp:size", {
  defaultValue: "medium",
  values: ["small", "medium", "large"],
});

Parameters

Name	Description
`uniqueId`	`string;` Each StyleProp must have a unique ID. We recommend you prefix this with your app/library name.
`options`	`{ defaultValue: Values[number]; values: Values; };` `defaultValue`: The default value for this style prop. `values`: An array of possible values of this style prop.

Returns

EnumStyleProp<Values[number]>;

addValues( )

Add new values to this enum style prop at runtime. This is useful for extending the built-in styles with custom values (e.g. adding custom colors). Be sure to also modify the associated types.

addValues(...newValues: T[]): void;

Parameters

Name	Description
`newValues`	`T[];` The new values to add.

Returns

void;

removeValues( )

Remove values from this enum style prop at runtime. This is useful for narrowing the built-in styles with custom values (e.g. adding custom colors). Be sure to also modify the associated types.

removeValues(...valuesToRemove: T[]): void;

Parameters

Name	Description
`valuesToRemove`	`T[];` The values to remove.

Returns

void;

setDefaultValue( )

from StyleProp

setDefaultValue(value: Type): void;

Parameters

Name	Description
`value`	`Type;`

Returns

void;

validate( )

from StyleProp

validate(value: unknown): Type;

Parameters

Name	Description
`value`	`unknown;`

Returns

Type;

validateUsingKnownGoodVersion( )

from StyleProp

validateUsingKnownGoodVersion(prevValue: Type, newValue: unknown): Type;

Parameters

Name	Description
`prevValue`	`Type;`
`newValue`	`unknown;`

Returns

Type;