Skip to content

TextBlock

The TextBlock component is used to render text. Internally, it simply outputs an HTML p element containing the text.

Using the TextBlock component is simple. After importing it, you can add text as a child element.

import TextBlock from '@components/Basic/TextBlock/TextBlock';
const App = () => {
return (
<>
<TextBlock>
Text content.
</TextBlock>
</>
);
};
export default App;
Prop NameTypeDefaultDescription
styleJSX.CSSProperties{}Styles applied directly to the root element of the component..
classstring""Additional CSS classes to apply to the component.
refHTMLButtonElement | undefinedundefinedObtains the component’s DOM element and assigns it to a variable, allowing direct access to the HTML element via the ref object.
onActionRecord<string, (scope?: string, ...args: any[]) => void>undefinedAllows you to add custom navigation action handlers to the component. See the Navigation component documentation for details.
anchorstring | HTMLElementundefinedLinks navigation to another element. When the anchor element is focused, the component’s actions will execute. Can be a CSS selector or HTMLElement.

To access the HTML element of the component and make modifications, you can add a ref property to the text block.

import TextBlock from '@components/Basic/TextBlock/TextBlock';
const App = () => {
let ref: HTMLParagraphElement;
return (
<TextBlock ref={ref!}>
Text content.
</TextBlock>
);
};
export default App;