f470e271fa
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
154 lines
4.7 KiB
Plaintext
154 lines
4.7 KiB
Plaintext
---
|
|
title: Chip
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/github/github-header.png" alt="Cabeçalho" />
|
|
</Frame>
|
|
|
|
Um elemento visual que você pode usar como um contêiner clicável ou não clicável com um rótulo, componentes opcionais à esquerda e à direita e várias opções de estilo para exibir rótulos e tags.
|
|
|
|
<Tabs>
|
|
|
|
<Tab title="Uso">
|
|
|
|
```jsx
|
|
import { Chip } from 'twenty-ui/components';
|
|
|
|
export const MyComponent = () => {
|
|
return (
|
|
<Chip
|
|
size="large"
|
|
label="Clickable Chip"
|
|
clickable={true}
|
|
variant="highlighted"
|
|
accent="text-primary"
|
|
leftComponent
|
|
rightComponent
|
|
maxWidth="200px"
|
|
className
|
|
/>
|
|
);
|
|
};
|
|
|
|
```
|
|
|
|
</Tab>
|
|
|
|
<Tab title="Propriedades">
|
|
|
|
|
|
| Propriedades | Tipo | Descrição |
|
|
| ------------ | ------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
| linkToEntity | string | O link para a entidade |
|
|
| entityId | string | O identificador único para a entidade |
|
|
| nome | string | O nome da entidade |
|
|
| pictureUrl | string | s imagem", |
|
|
| avatarType | Tipo de Avatar | O tipo de avatar que você deseja exibir. Tem duas opções: `arredondado` e `quadrado` |
|
|
| variant | Enum `EntityChipVariant` | Variante do chip de entidade que você deseja exibir. Tem duas opções: `regular` e `transparente` |
|
|
| LeftIcon | IconComponent | Um componente React representando um ícone. Exibido no lado esquerdo do chip |
|
|
|
|
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Exemplos
|
|
|
|
### Chip Transparente Desativado
|
|
|
|
```jsx
|
|
import { Chip } from 'twenty-ui/components';
|
|
|
|
export const MyComponent = () => {
|
|
return (
|
|
<Chip
|
|
size="large"
|
|
label="Transparent Disabled Chip"
|
|
clickable={false}
|
|
variant="rounded"
|
|
accent="text-secondary"
|
|
leftComponent
|
|
rightComponent
|
|
maxWidth="200px"
|
|
className
|
|
/>
|
|
);
|
|
};
|
|
|
|
```
|
|
|
|
<br />
|
|
|
|
### Chip Desativado com Tooltip
|
|
|
|
```jsx
|
|
import { Chip } from "twenty-ui/components";
|
|
|
|
export const MyComponent = () => {
|
|
return (
|
|
<Chip
|
|
size="large"
|
|
label="Disabled chip that triggers a tooltip when overflowing."
|
|
clickable={false}
|
|
variant="regular"
|
|
accent="text-primary"
|
|
leftComponent
|
|
rightComponent
|
|
maxWidth="200px"
|
|
className
|
|
/>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Chip de Entidade
|
|
|
|
Um elemento semelhante a um chip para exibir informações sobre uma entidade.
|
|
|
|
<Tabs>
|
|
|
|
<Tab title="Uso">
|
|
|
|
```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="Entity name"
|
|
pictureUrl=""
|
|
avatarType="rounded"
|
|
variant="regular"
|
|
LeftIcon={IconTwentyStar}
|
|
/>
|
|
</Router>
|
|
);
|
|
};
|
|
```
|
|
|
|
</Tab>
|
|
|
|
<Tab title="Propriedades">
|
|
|
|
|
|
| Propriedades | Tipo | Descrição |
|
|
| ------------ | ------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
| linkToEntity | string | O link para a entidade |
|
|
| entityId | string | O identificador único para a entidade |
|
|
| nome | string | O nome da entidade |
|
|
| pictureUrl | string | s imagem", |
|
|
| avatarType | Tipo de Avatar | O tipo de avatar que você deseja exibir. Tem duas opções: `arredondado` e `quadrado` |
|
|
| variant | Enum `EntityChipVariant` | Variante do chip de entidade que você deseja exibir. Tem duas opções: `regular` e `transparente` |
|
|
| LeftIcon | IconComponent | Um componente React representando um ícone. Exibido no lado esquerdo do chip |
|
|
|
|
|
|
|
|
</Tab>
|
|
</Tabs>
|