Some checks failed
App Prod-Parity E2E Dispatch / dispatch (push) Failing after 10s
CD Storybook UI / build (push) Failing after 3m25s
CD Storybook UI / dispatch (push) Has been skipped
CD deploy main / website-changed-files (push) Successful in 18m8s
CI Agent Skills / changed-files-check (push) Successful in 18m9s
CI Create App E2E minimal / changed-files-check (push) Successful in 24s
CI Create App / changed-files-check (push) Successful in 26s
CI Docs / changed-files-check (push) Successful in 26s
CI Emails / changed-files-check (push) Successful in 28s
CI Example App Hello World / changed-files-check (push) Successful in 23s
CI Front / changed-files-check (push) Has been skipped
CI Example App Postcard / changed-files-check (push) Successful in 27s
CI UI / changed-files-check (push) Has been skipped
CI Utils Test / changed-files-check (push) Successful in 45s
CI Twenty Apps / discover (push) Successful in 1m3s
CD deploy main / deploy-main (push) Failing after 3s
CI Agent Skills / agent-skills-validate (push) Has been skipped
CI Create App / create-app-test (lint) (push) Has been skipped
CI Emails / emails-test (push) Has been skipped
CI Front / front-task (lingui:compile) (push) Has been skipped
CI Front / front-task (lint) (push) Has been skipped
CI Example App Postcard / example-app-postcard (push) Has been skipped
CI UI / ui-task (lint) (push) Has been skipped
CI UI / ui-task (pack-size) (push) Has been skipped
CI UI / ui-task (size) (push) Has been skipped
CI UI / ui-task (test) (push) Has been skipped
CI UI / ui-task (typecheck) (push) Has been skipped
CI Utils Test / utils-test (push) Has been skipped
CI Twenty Apps / ${{ matrix.app.name }} (push) Has been skipped
CI Emails / ci-emails-status-check (push) Successful in 2s
CI Example App Hello World / ci-example-app-hello-world-status-check (push) Successful in 2s
CI Example App Postcard / ci-example-app-postcard-status-check (push) Successful in 3s
CI UI / ui-sb-test (push) Has been skipped
CI Utils Test / ci-utils-test-status-check (push) Successful in 2s
CI Twenty Apps / ci-twenty-apps-status-check (push) Successful in 2s
CI UI / ci-ui-status-check (push) Successful in 2s
CI Desktop / desktop (push) Failing after 1m8s
Push docs to Crowdin / Push documentation to Crowdin (push) Failing after 55s
Push translations to Crowdin / Extract and upload translations (push) Failing after 5s
Push website translations to Crowdin / Extract and upload website translations (push) Failing after 5s
CI Create App / create-app-test (test) (push) Has been skipped
CI Create App / create-app-test (typecheck) (push) Has been skipped
CI Docs / docs-lint (push) Has been skipped
CI Example App Hello World / example-app-hello-world (push) Has been skipped
CI Front / front-task (lingui:extract) (push) Has been skipped
CI Front / front-task (test) (push) Has been skipped
CI Front / front-task (typecheck) (push) Has been skipped
CI UI / ui-sb-build (push) Failing after 1m32s
CI Twenty Apps / ${{ matrix.app.name }} (${{ matrix.server-source }}) (push) Has been skipped
CI Agent Skills / agent-skills-publish (push) Has been skipped
CI Create App / ci-create-app-status-check (push) Successful in 2s
CI Agent Skills / agent-skills-remote-source (push) Has been skipped
CI Create App E2E minimal / create-app-e2e-minimal (push) Has been cancelled
CI E2E Main / e2e-test (push) Has been cancelled
CI Front / front-sb-build (push) Has been cancelled
CI Front / front-build (push) Has been cancelled
CI Create App E2E minimal / ci-create-app-e2e-minimal-status-check (push) Has been cancelled
CI E2E Main / ci-e2e-main-status-check (push) Has been cancelled
CI E2E Main / notify-main-ci-failure (push) Has been cancelled
CI E2E Main / qa-scout-comment (push) Has been cancelled
CI Front / front-sb-test (push) Has been cancelled
CI Front / front-sb-screenshots (push) Has been cancelled
CI Front / ci-front-status-check (push) Has been cancelled
DPA Sub-Processor Sync / sync-subprocessors (push) Failing after 3s
AI Catalog Sync / sync-catalog (push) Failing after 2s
81 lines
2.7 KiB
Plaintext
81 lines
2.7 KiB
Plaintext
---
|
|
title: Theming
|
|
description: Use Twenty UI theme tokens and scope theme overrides to part of your application.
|
|
---
|
|
|
|
Twenty UI components read public CSS custom properties prefixed with `--t-`. Prefer semantic tokens such as `background.secondary` and `font.color.primary` when styling your own components; these values adapt to the active palette.
|
|
|
|
## Use tokens in styles
|
|
|
|
`themeCssVariables` maps token paths to CSS variable references. Use it for values that CSS resolves:
|
|
|
|
```tsx
|
|
import { themeCssVariables } from 'twenty-ui/theme-constants';
|
|
|
|
export const Summary = () => (
|
|
<section
|
|
style={{
|
|
background: themeCssVariables.background.secondary,
|
|
color: themeCssVariables.font.color.primary,
|
|
padding: themeCssVariables.spacing[4],
|
|
borderRadius: themeCssVariables.border.radius.md,
|
|
}}
|
|
>
|
|
Three tasks are due today.
|
|
</section>
|
|
);
|
|
```
|
|
|
|
The equivalent CSS uses variables directly:
|
|
|
|
```css
|
|
.summary {
|
|
background: var(--t-background-secondary);
|
|
color: var(--t-font-color-primary);
|
|
padding: var(--t-spacing-4);
|
|
border-radius: var(--t-border-radius-md);
|
|
}
|
|
```
|
|
|
|
## Read resolved values
|
|
|
|
`useTheme()` reads the active provider's computed tokens. Use it when a component expects a JavaScript number, such as an icon size. The provider needs the theme stylesheet to be loaded in the browser to resolve CSS variables.
|
|
|
|
```tsx
|
|
import { IconCheck } from 'twenty-ui/icon';
|
|
import { useTheme } from 'twenty-ui/theme-constants';
|
|
|
|
export const CompleteIcon = () => {
|
|
const theme = useTheme();
|
|
|
|
return <IconCheck size={theme.icon.size.md} aria-hidden />;
|
|
};
|
|
```
|
|
|
|
Every entry in `themeCssVariables` is a CSS reference string, including numeric tokens. Do not perform arithmetic on those strings. On the server, resolved browser values are unavailable; see [Server rendering](/ui/ssr).
|
|
|
|
## Scope an override
|
|
|
|
Pass `applyToRoot={false}` to apply a theme to a subtree. Override public CSS variables by their full name:
|
|
|
|
```tsx
|
|
import { type ReactNode } from 'react';
|
|
import { ThemeProvider } from 'twenty-ui/theme-constants';
|
|
|
|
export const EmbeddedPanel = ({ children }: { children: ReactNode }) => (
|
|
<ThemeProvider
|
|
colorScheme="light"
|
|
applyToRoot={false}
|
|
overrides={{ '--t-background-secondary': '#f4f6ff' }}
|
|
>
|
|
{children}
|
|
</ThemeProvider>
|
|
);
|
|
```
|
|
|
|
A scoped provider adds a wrapper with `display: contents`; it does not create a layout box. It also supplies a container for components that support themed portals. Portals created by other libraries need their own container configuration.
|
|
|
|
Variables prefixed with `--tw-` are private component details. Use public props and `--t-` tokens instead of depending on those variables.
|
|
|
|
See the [token reference](/ui/tokens) for the available names and palette values.
|