Skip to content

The open alternative to Salesforce, designed for AI.

2.6 KB
Raw Blame
---
title: LightButton
description: Present lightweight actions with standard or subtle emphasis.
---

import { PageBanner } from "/snippets/page-banner.mdx"

import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';

import LightButtonReference from '/snippets/ui/generated/components/input/light-button.mdx';

## Overview

Use the shared `LightButton` component for a lightweight action. It composes
[Button](/ui/primitives/input/button) with a ghost surface, small size, regular
font weight, and no elevation.

<StoryEmbed
  storyId="ui-components-lightbutton--display"
  title="LightButton example"
  height={100}
/>

## Usage

```tsx
import { LightButton } from 'twenty-ui/components/input';

export const FilterAction = () => <LightButton>Add filter</LightButton>;
```

## Visual options

Compare standard and subtle emphasis across common action states.

<StoryEmbed
  storyId="ui-components-lightbutton--catalog"
  title="Light button emphasis and states"
  height={230}
/>

## State ownership

`LightButton` uses Button's state model and adds no state of its own. Your application supplies `loading` and `disabled`; `emphasis` only changes appearance. See [Button's state ownership example](/ui/primitives/input/button#state-ownership) for managing an asynchronous action. There are no controlled and uncontrolled selection modes.

## Emphasis and icons

```tsx
import { LightButton } from 'twenty-ui/components/input';
import { IconPlus } from 'twenty-ui/icon';

export const FilterActions = () => (
  <LightButton emphasis="subtle" startIcon={<IconPlus />}>
    Add filter
  </LightButton>
);
```

The default `emphasis="standard"` uses secondary neutral text.
`emphasis="subtle"` uses tertiary neutral text on ghost, outline, and soft
surfaces. Semantic colors and solid surfaces retain their contrast treatment.

Override `variant`, `color`, `size`, or `elevated` when needed.
[ButtonGroup](/ui/primitives/input/button-group) can set a shared size, surface,
and color. Explicit child appearance takes precedence over the group, followed by
the component defaults. Subtle emphasis does not replace the semantic color.

## Interaction

`LightButton` accepts Button's native attributes, refs, event handlers, icon
slots, loading and disabled states, and render composition. Its native default
is `type="button"`. Set `type="submit"` for submission or use `href` for a link.
Supply `render` to choose a custom root, including an application-owned router
link. Set `nativeButton={false}` and `role="link"` for a navigation renderer.
Custom native buttons keep `nativeButton` true.

## Props

<LightButtonReference />

<PageBanner illustration="page-cover-pointer" />