Skip to content

[v12] feat(ui-pill): Pill rework #2293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
git-nandor merged 1 commit into from
Dec 16, 2025
Merged

[v12] feat(ui-pill): Pill rework #2293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/guides/upgrade-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,37 @@ The new icons automatically sync with theme changes, support all InstUI color to
- `alert` color has been removed. Please use `primary` instead.
- Some prop values have been deprecated, see [Text](/Text) for more details.

### Pill

#### Deprecated color prop values

The following `color` prop values have been **removed**:

- `'danger'` - use `'error'` instead
- `'alert'` - use `'info'` instead

#### Theme variable changes

- theme variable `fontFamily` has been added
- theme variable `padding` has been renamed to `paddingHorizontal` (now only controls horizontal padding)
- theme variable `background` has been renamed to `backgroundColor`
- theme variable `primaryColor` has been split into:
- `baseTextColor` (for text color)
- `baseBorderColor` (for border color)
- theme variable `successColor` has been split into:
- `successTextColor` (for text color)
- `successBorderColor` (for border color)
- theme variable `infoColor` has been split into:
- `infoTextColor` (for text color)
- `infoBorderColor` (for border color)
- theme variable `warningColor` has been split into:
- `warningTextColor` (for text color)
- `warningBorderColor` (for border color)
- theme variable `dangerColor` has been removed, replaced with:
- `errorTextColor` (for text color)
- `errorBorderColor` (for border color)
- theme variable `alertColor` has been removed (use `info*` variables instead)

## API Changes

### Focus rings
Expand Down
125 changes: 3 additions & 122 deletions packages/ui-pill/src/Pill/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,85 +11,6 @@ you can use the `statusLabel` prop to add a label to the left of the main text.
---
type: example
---
<div>

<InstUISettingsProvider theme={canvas}>
<div>
<Pill
margin="x-small"
>
Excused
</Pill>
<Pill
statusLabel="Status"
color="info"
margin="x-small"
>
Draft
</Pill>
<Pill
statusLabel="Status"
renderIcon={<IconCheckLine />}
color="success"
margin="x-small"
>
Checked In
</Pill>
<Pill
renderIcon={<IconClockLine />}
color="warning"
margin="x-small"
>
Late
</Pill>
<Pill
renderIcon={<IconMessageLine />}
color="error"
margin="x-small"
>
Notification
</Pill>
</div>
</InstUISettingsProvider>
<InstUISettingsProvider theme={canvasHighContrast}>
<div>
<Pill
margin="x-small"
>
Excused
</Pill>
<Pill
statusLabel="Status"
color="info"
margin="x-small"
>
Draft
</Pill>
<Pill
statusLabel="Status"
renderIcon={<IconCheckLine />}
color="success"
margin="x-small"
>
Checked In
</Pill>
<Pill
renderIcon={<IconClockLine />}
color="warning"
margin="x-small"
>
Late
</Pill>
<Pill
renderIcon={<IconMessageLine />}
color="error"
margin="x-small"
>
Notification
</Pill>
</div>
</InstUISettingsProvider>
<InstUISettingsProvider theme={rebrandLight}>
<div>
<Pill
margin="x-small"
Expand All @@ -105,67 +26,27 @@ type: example
</Pill>
<Pill
statusLabel="Status"
renderIcon={<IconCheckLine />}
renderIcon={<CheckInstUIIcon size="sm" />}
color="success"
margin="x-small"
>
Checked In
</Pill>
<Pill
renderIcon={<IconClockLine />}
renderIcon={<Clock4InstUIIcon size="sm" />}
color="warning"
margin="x-small"
>
Late
</Pill>
<Pill
renderIcon={<IconMessageLine />}
renderIcon={<MailInstUIIcon size="sm" />}
color="error"
margin="x-small"
>
Notification
</Pill>
</div>
</InstUISettingsProvider>
<InstUISettingsProvider theme={rebrandDark}>
<div>
<Pill
margin="x-small"
>
Excused
</Pill>
<Pill
statusLabel="Status"
color="info"
margin="x-small"
>
Draft
</Pill>
<Pill
statusLabel="Status"
renderIcon={<IconCheckLine />}
color="success"
margin="x-small"
>
Checked In
</Pill>
<Pill
renderIcon={<IconClockLine />}
color="warning"
margin="x-small"
>
Late
</Pill>
<Pill
renderIcon={<IconMessageLine />}
color="error"
margin="x-small"
>
Notification
</Pill>
</div>
</InstUISettingsProvider>
</div>
```

The component has a `max-width`, set by its theme. Any overflowing text will be handled via ellipses.
Expand Down
6 changes: 3 additions & 3 deletions packages/ui-pill/src/Pill/styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ const generateStyle = (
label: 'pill',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
boxSizing: 'border-box',
padding: `0 ${componentTheme.paddingHorizontal}`,
background: componentTheme.backgroundColor,
borderWidth: componentTheme.borderWidth,
borderStyle: componentTheme.borderStyle,
borderRadius: componentTheme.borderRadius,
/* line-height does not account for top/bottom border width */
lineHeight: `calc(${componentTheme.height} - (${componentTheme.borderWidth} * 2))`,
fontFamily: componentTheme.fontFamily,
height: componentTheme.height,
lineHeight: componentTheme.lineHeight,
...pillColorVariants[color!]
},
status: {
Expand Down
Loading