mirror of
https://github.com/apache/superset.git
synced 2026-05-22 08:15:36 +00:00
4266d36cf4
Snapshots all four versioned Docusaurus sections at v6.1.0, cut from master after the version-cutting tooling (#39837) and broken-internal- links fixes (#40102) landed. Captures fresh auto-generated content and freezes data dependencies so the historical snapshot stays correct. Versioning behavior: lastVersion stays at current for every section, so the canonical URLs (/docs/..., /admin-docs/..., /developer-docs/..., /components/...) continue to render content from master. The current version is consistently labeled "Next" with an unreleased banner, and 6.1.0 is a historical pin accessible only via its explicit version segment. Component playground: previously disabled: true in versions-config.json, now enabled and versioned. The plugin block in docusaurus.config.ts was already gated only by the disabled flag, so no other code changes were needed to bring it back online. Snapshot includes: - All MDX content for the four sections. - Auto-gen captured fresh: 74 database pages (engine spec metadata), ~1,800 API reference files (openapi.json), 59 component pages (Storybook stories). - Data imports frozen at cut time into snapshot-local _versioned_data/ dirs: versioned_docs/version-6.1.0/_versioned_data/src/data/databases.json (canonical 80-database diagnostics from master, preserved by the generator's input-hash cache) admin_docs_versioned_docs/version-6.1.0/_versioned_data/data/countries.json admin_docs_versioned_docs/version-6.1.0/_versioned_data/static/feature-flags.json developer_docs_versioned_docs/version-6.1.0/_versioned_data/static/data/components.json - Import paths in deeply-nested files rewritten so they still resolve from one directory deeper inside the snapshot. Verified via full yarn build: exit 0, no broken links surfaced by onBrokenLinks: throw. Anchor warnings present are pre-existing on master (community#superset-community-calendar) and unrelated.
132 lines
3.3 KiB
Plaintext
132 lines
3.3 KiB
Plaintext
---
|
|
title: Alert
|
|
sidebar_label: Alert
|
|
---
|
|
|
|
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one
|
|
or more contributor license agreements. See the NOTICE file
|
|
distributed with this work for additional information
|
|
regarding copyright ownership. The ASF licenses this file
|
|
to you under the Apache License, Version 2.0 (the
|
|
"License"); you may not use this file except in compliance
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations
|
|
under the License.
|
|
-->
|
|
|
|
import { StoryWithControls } from '../../../../src/components/StorybookWrapper';
|
|
import { Alert } from '@apache-superset/core/components';
|
|
|
|
# Alert
|
|
|
|
Alert component for displaying important messages to users. Wraps Ant Design Alert with sensible defaults and improved accessibility.
|
|
|
|
## Live Example
|
|
|
|
<StoryWithControls
|
|
component={Alert}
|
|
props={{
|
|
closable: true,
|
|
type: 'info',
|
|
message: 'This is a sample alert message.',
|
|
description: 'Sample description for additional context.',
|
|
showIcon: true
|
|
}}
|
|
controls={[
|
|
{
|
|
name: 'type',
|
|
label: 'Type',
|
|
type: 'select',
|
|
options: [
|
|
'info',
|
|
'error',
|
|
'warning',
|
|
'success'
|
|
]
|
|
},
|
|
{
|
|
name: 'closable',
|
|
label: 'Closable',
|
|
type: 'boolean'
|
|
},
|
|
{
|
|
name: 'showIcon',
|
|
label: 'Show Icon',
|
|
type: 'boolean'
|
|
},
|
|
{
|
|
name: 'message',
|
|
label: 'Message',
|
|
type: 'text'
|
|
},
|
|
{
|
|
name: 'description',
|
|
label: 'Description',
|
|
type: 'text'
|
|
}
|
|
]}
|
|
/>
|
|
|
|
## Try It
|
|
|
|
Edit the code below to experiment with the component:
|
|
|
|
```tsx live
|
|
function Demo() {
|
|
return (
|
|
<Alert
|
|
closable
|
|
type="info"
|
|
message="This is a sample alert message."
|
|
description="Sample description for additional context."
|
|
showIcon
|
|
/>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
|------|------|---------|-------------|
|
|
| `closable` | `boolean` | `true` | Whether the Alert can be closed with a close button. |
|
|
| `type` | `string` | `"info"` | Type of the alert (e.g., info, error, warning, success). |
|
|
| `message` | `string` | `"This is a sample alert message."` | Message |
|
|
| `description` | `string` | `"Sample description for additional context."` | Description |
|
|
| `showIcon` | `boolean` | `true` | Whether to display an icon in the Alert. |
|
|
|
|
## Usage in Extensions
|
|
|
|
This component is available in the `@apache-superset/core/components` package, which is automatically available to Superset extensions.
|
|
|
|
```tsx
|
|
import { Alert } from '@apache-superset/core/components';
|
|
|
|
function MyExtension() {
|
|
return (
|
|
<Alert
|
|
closable
|
|
type="info"
|
|
message="This is a sample alert message."
|
|
/>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Source Links
|
|
|
|
- [Story file](https://github.com/apache/superset/blob/master/superset-frontend/packages/superset-core/src/ui/components/Alert/Alert.stories.tsx)
|
|
- [Component source](https://github.com/apache/superset/blob/master/superset-frontend/packages/superset-core/src/ui/components/Alert/index.tsx)
|
|
|
|
---
|
|
|
|
*This page was auto-generated from the component's Storybook story.*
|