Files

T

Félix Malfait a9d996ff7e Clarify application licensing and add trademark policy (#23564 )

## What

- `twenty-sdk`, `twenty-client-sdk`, `create-twenty-app`,
`twenty-shared` and `twenty-ui` are now MIT (package.json + LICENSE
files). The SDKs are bundled into third-party applications and app front
components import twenty-ui, so these need a permissive license for apps
to be licensable by their authors. `twenty-shared` is included because
both SDKs inline it at build time; an MIT SDK bundling AGPL code would
defeat the purpose. Apps under `packages/twenty-apps` were already MIT.
- Added a "Twenty Application Exception" to LICENSE (additional
permission under AGPLv3 section 7): applications that interact with
Twenty through the app platform interfaces (APIs, manifests, logic
functions, front components, SDKs) are not subject to copyleft and can
be licensed freely by their authors. Modifying Twenty itself remains
fully AGPL, including the network clause.
- Rewrote the LICENSE intro to describe the three licensing zones (AGPL,
Enterprise-marked files, MIT packages) and fixed the intro incorrectly
saying "GPL".
- Added TRADEMARK.md: what anyone can do without asking (self-host,
"built on Twenty", forks under their own name) and what requires
permission (using the name or logo for a product, domain, or hosted
offering).

## Why

Gives app developers and partners legal certainty that building on the
platform does not pull their apps under AGPL, while the core stays AGPL.

The exception and trademark wording should get a legal review before
being announced.

2026-07-30 16:55:19 +02:00

2.9 KiB

Raw Blame History

twenty-ui

Twenty's open-source React UI component library: components, icons, and design tokens built on a zero-runtime, CSS-variable styling layer.

Installation

npm install twenty-ui

react, react-dom, and monaco-editor are peer dependencies (install them in your app). monaco-editor is only required if you use the code editor components.

Usage

Import the base styles once, pick a theme stylesheet, and wrap your app in ThemeProvider:

import { ThemeProvider } from 'twenty-ui/theme-constants';
import { Button } from 'twenty-ui/input';

import 'twenty-ui/style.css';
import 'twenty-ui/theme-light.css';

export const App = () => (
  <ThemeProvider colorScheme="light">
    <Button title="Click me" />
  </ThemeProvider>
);

Components are available from the root entry point or from a specific subpath for better tree-shaking:

import { Button } from 'twenty-ui';
import { Button } from 'twenty-ui/input';

Entry points

Subpath	Contents
`twenty-ui`	All components, icons, theme tokens, and utilities
`twenty-ui/accessibility`	Accessibility helpers
`twenty-ui/assets`	Logos and static assets
`twenty-ui/data-display`	Avatars, chips, tags, and other display components
`twenty-ui/feedback`	Progress bars, loaders, and status feedback
`twenty-ui/icon`	Icon components and the icon provider
`twenty-ui/input`	Buttons, toggles, and form inputs
`twenty-ui/json-visualizer`	JSON tree viewer
`twenty-ui/layout`	Layout primitives
`twenty-ui/navigation`	Menus, links, and navigation components
`twenty-ui/surfaces`	Cards, tooltips, and surface components
`twenty-ui/testing`	Storybook and test decorators
`twenty-ui/theme`	Theme types and helpers
`twenty-ui/theme-constants`	Design tokens, `ThemeProvider`, and `useTheme`
`twenty-ui/typography`	Text and typography components
`twenty-ui/utilities`	Hooks and shared utilities

Theming

twenty-ui/style.css ships the base reset and component styles. Import it once.
twenty-ui/theme-light.css and twenty-ui/theme-dark.css define the design-token CSS variables for each color scheme.
ThemeProvider exposes the active theme through useTheme() and applies the light / dark class. Pass applyToRoot={false} with overrides to scope a theme to a subtree instead of the document root.

Development

npx nx build twenty-ui                 # Build the library (dual ESM/CJS + types)
npx nx storybook:serve:dev twenty-ui   # Run Storybook
npx nx test twenty-ui                  # Run unit tests

License

twenty-ui is released under the MIT license.

2.9 KiB Raw Blame History