Skip to content

The open alternative to Salesforce, designed for AI.

3.3 KB
Raw Blame
{/*
 * _____                    _
 *|_   _|_      _____ _ __ | |_ _   _
 *  | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
 *  | |  \ V  V /  __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
 *  |_|   \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
 *                              |___/
 *
 * This file is generated from the documentation data in packages/twenty-ui/generated.
 * To update it, edit the component prop types or design tokens in twenty-ui and run:
 *   npx nx generate:ui twenty-docs
 */}

### Section.Root

<ParamField body="Root.align" type="&quot;center&quot; | &quot;left&quot;" default="left">
  Text alignment within the section. Defaults to `left`.
</ParamField>

<ParamField body="Root.color" type="&quot;primary&quot; | &quot;secondary&quot; | &quot;tertiary&quot;" default="primary">
  Text color within the section. Defaults to `primary`.
</ParamField>

<ParamField body="Root.fullWidth" type="boolean" default="true">
  Whether the section fills the available width. Defaults to `true`.
</ParamField>

<ParamField body="Root.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, {}&gt;">
  Allows you to replace the component's HTML element
  with a different tag, or compose it with another component.

  Accepts a `ReactElement` or a function that returns the element to render.
</ParamField>

### Section.Header

<ParamField body="Header.actions" type="ReactNode">
  Content alongside the heading, such as an action button or status.
</ParamField>

<ParamField body="Header.color" type="&quot;primary&quot; | &quot;secondary&quot; | &quot;tertiary&quot;" default="primary">
  Theme font color. Defaults to `primary`.
</ParamField>

<ParamField body="Header.description" type="ReactNode">
  Supporting text associated with the heading. Strings have optional truncation and overflow tooltips; React nodes render as supplied.
</ParamField>

<ParamField body="Header.descriptionLineClamp" type="number | false" default="5">
  Maximum visible lines for a string description. Defaults to `5`; use `false` to display the full description without a tooltip.
</ParamField>

<ParamField body="Header.isDescriptionFocusable" type="boolean" default="false">
  Adds a tab stop to a truncated string description so its overflow tooltip can open on focus. Defaults to `false`.
</ParamField>

<ParamField body="Header.level" type="1 | 2 | 3 | 4 | 5 | 6" default="2">
  Semantic heading level, from `h1` through `h6`. Does not change the visual size. Defaults to `2`.
</ParamField>

<ParamField body="Header.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, {}&gt;">
  Allows you to replace the component's HTML element
  with a different tag, or compose it with another component.

  Accepts a `ReactElement` or a function that returns the element to render.
</ParamField>

<ParamField body="Header.size" type="&quot;lg&quot; | &quot;md&quot; | &quot;sm&quot; | &quot;xl&quot; | &quot;xs&quot; | &quot;xxl&quot;" default="md">
  Visual font size from `xs` through `xxl`, independent of the heading level. Uses the matching font token. Defaults to `md`.
</ParamField>

<ParamField body="Header.title" type="ReactNode" required>
  Content of the section heading.
</ParamField>