LineBreakRun Class
A Run that represents the end of a line of text within a Paragraph. It contains no content of its own - it simply causes subsequent content to display on a new line.
Extends
Methods
| Name | Description | |
|---|---|---|
| clone(): LineBreakRun | Create a deep copy of this component. | |
| equals(other: TextBlockComponent): boolean | Returns true if this is equivalent to other. |
|
| stringify(options?: TextBlockStringifyOptions): string | Simply returns lineBreak. | |
| toJSON(): LineBreakRunProps | Convert this component to its JSON representation. | |
| create(props: TextBlockComponentProps): LineBreakRun Static |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| applyStyle(styleName: string, options?: ApplyTextStyleOptions): void | TextBlockComponent | Apply the TextStyle specified by styleName to this component, optionally preserving styleOverrides and/or preventing propagation to sub-components. |
| clearStyleOverrides(): void | TextBlockComponent | Reset any styleOverrides applied to this component's TextStyle. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| type Readonly | "linebreak" | Discriminator field for the Run union. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| overridesStyle Accessor ReadOnly | boolean | TextBlockComponent | Returns true if styleOverrides specifies any deviations from this component's base TextStyle. |
| styleName Accessor | string | TextBlockComponent | The name of the TextStyle that provides the base formatting for the contents of this component. |
| styleOverrides Accessor | TextStyleSettingsProps | TextBlockComponent | Deviations in individual properties of the TextStyle specified by styleName. For example, if the style uses the "Arial" font, you can override that by settings styleOverrides.fontName to "Comic Sans". |
Defined in
Last Updated: 05 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.