@highlight-ui/alert
Advanced tools
Using npm:
npm install @highlight-ui/alert
Using yarn:
yarn add @highlight-ui/alert
Using pnpm:
pnpm install @highlight-ui/alert
In your (S)CSS file:
@import url('@highlight-ui/alert');
Once the package is installed, you can import the library:
import { Alert, InlineAlert } from '@highlight-ui/alert';
import React, { useState } from 'react';
import { Alert } from '@highlight-ui/alert';
export default function AlertExample() {
return <Alert status="highlight">This is an alert!</Alert>;
}
⚠️⚠️⚠️⚠️ As of version 7.0.0 on both Alert and InlineAlert the pre-defined typographic style on children are removed. ⚠️⚠️⚠️⚠️
so for the component to work properly use next suggestion as an example
In your (S)CSS file:
@import url('@highlight-ui/alert');
@import url('@highlight-ui/typography');
In your TS(X) file:
import React, { useState } from 'react';
import { Body } from '@highlight-ui/typography';
import { Alert } from '@highlight-ui/alert';
export default function AlertExample() {
return (
<Alert status="highlight">
<Body color="text-default">This is an alert!</Body>
</Alert>
);
}
| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
status | 'highlight', 'success', 'warning', 'critical' | Yes | Defines which variant of the Alert to render | |
id | string | No | Gives the alert an id | |
actions | React.ReactNode | No | Allows rendering a ReactNode (a button is intended) below the alert content | |
enableCloseButton | boolean | No | false | Allows showing a close button |
fullWidth | boolean | No | false | If true, uses 100% of its container width |
iconColor | IconColorToken | No | Passes a color to the icon | |
iconFamily | 'regular', 'light', 'solid' | No | solid | Passes a font family to the icon |
iconSize | number | No | 16 | Passes a size to the icon |
iconName | string | No | Passes an icon name to the icon | |
onClickCloseButton | () => void | No | Passes a function to onClick() of the close button |
| Type | Values | Description |
|---|---|---|
IconColorToken | "Icon" and "Icon On" color token names | A type exported by the @highlight-ui/icon package |
Please visit personio.design for usage guidelines and visual examples.
If you're interested in contributing, please visit our contribution page.
FAQs
This is the Alert component used in Personio
We found that @highlight-ui/alert demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."