Skip to content

The open alternative to Salesforce, designed for AI.

1.6 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
 */}

<ParamField body="className" type="string">
  Additional CSS class applied to the root element.
</ParamField>

<ParamField body="endElement" type="ReactNode">
  Content shown at the end of the header, such as actions. Use a fragment for multiple elements.
</ParamField>

<ParamField body="ref" type="Ref&lt;HTMLDivElement&gt;">
  Ref forwarded to the rendered root element, a div by default.
</ParamField>

<ParamField body="render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, {}&gt;">
  Replace the root div or compose it with another component. Native props and refs target the rendered root.
</ParamField>

<ParamField body="startElement" type="ReactNode">
  Content shown at the start of the header, before the title, such as tabs. Use a fragment for multiple elements.
</ParamField>

<ParamField body="style" type="CSSProperties">
  Inline styles applied to the root element.
</ParamField>

<ParamField body="title" type="ReactNode">
  Content shown after `startElement`. This is visible header content, not the native HTML title attribute.
</ParamField>