8bb98c309a
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
154 lines
4.9 KiB
Plaintext
154 lines
4.9 KiB
Plaintext
---
|
|
title: Chip
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/github/github-header.png" alt="Kopfzeile" />
|
|
</Frame>
|
|
|
|
Ein visuelles Element, das Sie als klickbaren oder nicht klickbaren Container mit einem Etikett, optionalen linken und rechten Komponenten und verschiedenen Stiloptionen verwenden können, um Etiketten und Tags anzuzeigen.
|
|
|
|
<Tabs>
|
|
|
|
<Tab title=""Verwendung"">
|
|
|
|
```jsx
|
|
import { Chip } from 'twenty-ui/components';
|
|
|
|
export const MyComponent = () => {
|
|
return (
|
|
<Chip
|
|
size="large"
|
|
label="Anklickbarer Chip"
|
|
clickable={true}
|
|
variant="highlighted"
|
|
accent="text-primary"
|
|
leftComponent
|
|
rightComponent
|
|
maxWidth="200px"
|
|
className
|
|
/>
|
|
);
|
|
};
|
|
|
|
```
|
|
|
|
</Tab>
|
|
|
|
<Tab title=""Eigenschaften"">
|
|
|
|
|
|
| Props | Typ | Beschreibung |
|
|
| ------------ | ------------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
| linkToEntity | Zeichenkette | Der Link zur Entität |
|
|
| entityId | Zeichenkette | Der eindeutige Identifikator für die Entität |
|
|
| name | string | Der Name der Entität |
|
|
| pictureUrl | Zeichenkette | s Bild", |
|
|
| avatarType | Avatar-Typ | Der Typ des Avatars, den Sie anzeigen möchten. Hat zwei Optionen: `abgerundet` und `quadratisch` |
|
|
| Variante | `EntityChipVariante` enum | Variante des Entity-Chips, die Sie anzeigen möchten. Hat zwei Optionen: `regelmäßig` und `transparent` |
|
|
| LeftIcon | Icon-Komponente | Eine React-Komponente, die ein Symbol darstellt. Wird auf der linken Seite des Chips angezeigt |
|
|
|
|
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Beispiele
|
|
|
|
### Transparenter deaktivierter Chip
|
|
|
|
```jsx
|
|
import { Chip } from 'twenty-ui/components';
|
|
|
|
export const MyComponent = () => {
|
|
return (
|
|
<Chip
|
|
size="large"
|
|
label="Transparenter deaktivierter Chip"
|
|
clickable={false}
|
|
variant="rounded"
|
|
accent="text-secondary"
|
|
leftComponent
|
|
rightComponent
|
|
maxWidth="200px"
|
|
className
|
|
/>
|
|
);
|
|
};
|
|
|
|
```
|
|
|
|
<br />
|
|
|
|
### Deaktivierter Chip mit Tooltip
|
|
|
|
```jsx
|
|
import { Chip } from "twenty-ui/components";
|
|
|
|
export const MyComponent = () => {
|
|
return (
|
|
<Chip
|
|
size="large"
|
|
label="Deaktivierter Chip, der bei Überlauf einen Tooltip auslöst."
|
|
clickable={false}
|
|
variant="regular"
|
|
accent="text-primary"
|
|
leftComponent
|
|
rightComponent
|
|
maxWidth="200px"
|
|
className
|
|
/>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Entity-Chip
|
|
|
|
Ein Chip-ähnliches Element, um Informationen über eine Entität anzuzeigen.
|
|
|
|
<Tabs>
|
|
|
|
<Tab title="Verwendung">
|
|
|
|
```jsx
|
|
import { BrowserRouter as Router } from 'react-router-dom';
|
|
import { IconTwentyStar } from 'twenty-ui/display';
|
|
import { Chip } from 'twenty-ui/components';
|
|
|
|
export const MyComponent = () => {
|
|
return (
|
|
<Router>
|
|
<Chip
|
|
linkToEntity="/entity-link"
|
|
entityId="entityTest"
|
|
name="Entitätsname"
|
|
pictureUrl=""
|
|
avatarType="rounded"
|
|
variant="regular"
|
|
LeftIcon={IconTwentyStar}
|
|
/>
|
|
</Router>
|
|
);
|
|
};
|
|
```
|
|
|
|
</Tab>
|
|
|
|
<Tab title="Eigenschaften">
|
|
|
|
|
|
| Props | Typ | Beschreibung |
|
|
| ------------ | ------------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
| linkToEntity | string | Der Link zur Entität |
|
|
| entityId | string | Der eindeutige Identifikator für die Entität |
|
|
| name | string | Der Name der Entität |
|
|
| pictureUrl | Zeichenfolge | s Bild", |
|
|
| avatarType | Avatar-Typ | Der Typ des Avatars, den Sie anzeigen möchten. Hat zwei Optionen: `abgerundet` und `quadratisch` |
|
|
| Variante | `EntityChipVariante` enum | Variante des Entity-Chips, die Sie anzeigen möchten. Hat zwei Optionen: `regelmäßig` und `transparent` |
|
|
| LeftIcon | Icon-Komponente | Eine React-Komponente, die ein Symbol darstellt. Wird auf der linken Seite des Chips angezeigt |
|
|
|
|
|
|
|
|
</Tab>
|
|
</Tabs>
|