Spaces:
Paused
Paused
| --- | |
| title: Label | |
| sidebar_label: Label | |
| --- | |
| <!-- | |
| 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'; | |
| # Label | |
| The Label component from Superset's UI library. | |
| ## Live Example | |
| <StoryWithControls | |
| component="Label" | |
| props={{ | |
| type: 'default', | |
| children: 'Label text', | |
| monospace: false, | |
| }} | |
| controls={[ | |
| { | |
| name: 'type', | |
| label: 'Type', | |
| type: 'select', | |
| options: ['default', 'info', 'success', 'warning', 'error', 'primary'], | |
| description: 'The visual style of the label.', | |
| }, | |
| { | |
| name: 'children', | |
| label: 'Children', | |
| type: 'text', | |
| description: 'The label text content.', | |
| }, | |
| { | |
| name: 'monospace', | |
| label: 'Monospace', | |
| type: 'boolean', | |
| description: 'Use monospace font.', | |
| }, | |
| ]} | |
| /> | |
| ## Try It | |
| Edit the code below to experiment with the component: | |
| ```tsx live | |
| function Demo() { | |
| return <Label type="default">Label text</Label>; | |
| } | |
| ``` | |
| ## Props | |
| | Prop | Type | Default | Description | | |
| | ----------- | --------- | -------------- | ------------------------------ | | |
| | `type` | `string` | `"default"` | The visual style of the label. | | |
| | `children` | `string` | `"Label text"` | The label text content. | | |
| | `monospace` | `boolean` | `false` | Use monospace font. | | |
| ## Import | |
| ```tsx | |
| import { Label } from '@superset-ui/core/components'; | |
| ``` | |
| --- | |
| :::tip[Improve this page] | |
| This documentation is auto-generated from the component's Storybook story. | |
| Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/Label/Label.stories.tsx). | |
| ::: | |