Class Decorator

This is an class that holds the information about decoration registered for each SchemaNode

Hierarchy

Decorator

Index

Constructors

constructor

Methods

Constructors

constructor

new Decorator(match: DecoratorMatcher): Decorator

- Defined in src/types.ts:256
Parameters
- match: DecoratorMatcher
Returns Decorator

Methods

appendWith

appendWith<T>(fc: T, props?: DecoratorPropsGetter<T>): Omit<Decorator, "apply">

- Defined in src/types.ts:287
the passed custom component will be placed after the node's current component

Type parameters
- T: Noop
Parameters
- fc: T
- Optional props: DecoratorPropsGetter<T>
Returns Omit<Decorator, "apply">

apply

apply(node: SchemaNode<any>): void

- Defined in src/types.ts:262
Used internaly, this is being called by all SchemaNode in order to know if they are concerned with that decorator

Parameters
- node: SchemaNode<any>
Returns void

packWith

packWith<T>(fc: T, props?: DecoratorPropsGetter<T>): Omit<Decorator, "apply">

- Defined in src/types.ts:304
similar to wrapWith but the passed custom component will wrap around the node's components including other attached decorators such as the ones added from prependWith, appendWith and wrapWith decoration verbs

Type parameters
- T: Noop
Parameters
- fc: T
- Optional props: DecoratorPropsGetter<T>
Returns Omit<Decorator, "apply">

prependWith

prependWith<T>(fc: T, props?: DecoratorPropsGetter<T>): Omit<Decorator, "apply">

- Defined in src/types.ts:280
the passed custom component will be placed before the node's current component

Type parameters
- T: Noop
Parameters
- fc: T
- Optional props: DecoratorPropsGetter<T>
Returns Omit<Decorator, "apply">

replaceWith

replaceWith<T>(fc: T, props?: DecoratorPropsGetter<T>): Omit<Decorator, "apply">

- Defined in src/types.ts:273
the passed custom component will replace the node's current component

Type parameters
- T: Noop
Parameters
- fc: T
- Optional props: DecoratorPropsGetter<T>
Returns Omit<Decorator, "apply">

wrapWith

wrapWith<T>(fc: T, props?: DecoratorPropsGetter<T>): Omit<Decorator, "apply">

- Defined in src/types.ts:295
the passed custom component will wrap arround the node's current component the props children will represents the node's current rendered component inside the custom component

Type parameters
- T: Noop
Parameters
- fc: T
- Optional props: DecoratorPropsGetter<T>
Returns Omit<Decorator, "apply">

Generated using TypeDoc