@highlight-ui/alert
Advanced tools
Readme
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
The npm package @highlight-ui/alert receives a total of 1,859 weekly downloads. As such, @highlight-ui/alert popularity was classified as popular.
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
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.