Interface: EnabledCurvedTextEffect
Properties
addCurveEffect
• addCurveEffect: (height?: number) => void
Type declaration
▸ (height?): void
Adds a Curved Text Effect to the selected item, using the given height or defaulting to the height of the selected item
Parameters
| Name | Type |
|---|---|
height? | number |
Returns
void
Defined in
packages/design-engine-react-components/src/hooks/useCurvedTextEffect/useCurvedTextEffect.ts:18
currentCurveHeight
• currentCurveHeight: undefined | number
The current height of the Curved Text Effect (in mm). Positive and negative values curve the text downwards and upwards, respectively.
Returns undefined if the item has an invalid textPath for Curved Text Effects, or if the textPath is not present.
Defined in
packages/design-engine-react-components/src/hooks/useCurvedTextEffect/useCurvedTextEffect.ts:28
isEnabled
• isEnabled: true
Returns true if there is a single TextAreaItem selected, it is not locked, and it could retrieve its CurvedTextExtension.
Defined in
packages/design-engine-react-components/src/hooks/useCurvedTextEffect/useCurvedTextEffect.ts:14
onChange
• onChange: (x: number) => void
Type declaration
▸ (x): void
Sets a temporary height value for the curve which will be reflected on item previews
Parameters
| Name | Type |
|---|---|
x | number |
Returns
void
Defined in
packages/design-engine-react-components/src/hooks/useCurvedTextEffect/useCurvedTextEffect.ts:32
onCommit
• onCommit: () => void
Type declaration
▸ (): void
Commits the current temporary height value to the text item on the document (creates a history step)
Returns
void
Defined in
packages/design-engine-react-components/src/hooks/useCurvedTextEffect/useCurvedTextEffect.ts:36
removeTextPath
• removeTextPath: () => void
Type declaration
▸ (): void
Removes any textPath currently present on the selected item (even if it is not a Curved Text Effect)
Returns
void
Defined in
packages/design-engine-react-components/src/hooks/useCurvedTextEffect/useCurvedTextEffect.ts:22