Spaces:
Paused
Paused
| --- | |
| title: Input | |
| sidebar_label: Input | |
| --- | |
| <!-- | |
| 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'; | |
| # Input | |
| The Input component from Superset's UI library. | |
| ## Live Example | |
| <StoryWithControls | |
| component="Input" | |
| props={{ | |
| allowClear: false, | |
| disabled: false, | |
| showCount: false, | |
| type: "text", | |
| variant: "outlined" | |
| }} | |
| controls={[ | |
| { | |
| name: "allowClear", | |
| label: "Allow Clear", | |
| type: "boolean" | |
| }, | |
| { | |
| name: "disabled", | |
| label: "Disabled", | |
| type: "boolean" | |
| }, | |
| { | |
| name: "showCount", | |
| label: "Show Count", | |
| type: "boolean" | |
| }, | |
| { | |
| name: "type", | |
| label: "Type", | |
| type: "select", | |
| options: [ | |
| "text", | |
| "password", | |
| "email", | |
| "number", | |
| "tel", | |
| "url", | |
| "search" | |
| ], | |
| description: "HTML input type" | |
| }, | |
| { | |
| name: "variant", | |
| label: "Variant", | |
| type: "select", | |
| options: [ | |
| "outlined", | |
| "borderless", | |
| "filled" | |
| ], | |
| description: "Input style variant" | |
| }, | |
| { | |
| name: "defaultValue", | |
| label: "Default Value", | |
| type: "text", | |
| description: "Default input value" | |
| }, | |
| { | |
| name: "id", | |
| label: "ID", | |
| type: "text", | |
| description: "HTML id attribute" | |
| }, | |
| { | |
| name: "maxLength", | |
| label: "Max Length", | |
| type: "number", | |
| description: "Maximum length of input" | |
| }, | |
| { | |
| name: "status", | |
| label: "Status", | |
| type: "select", | |
| options: [ | |
| "error", | |
| "warning" | |
| ], | |
| description: "Validation status" | |
| }, | |
| { | |
| name: "size", | |
| label: "Size", | |
| type: "select", | |
| options: [ | |
| "large", | |
| "middle", | |
| "small" | |
| ], | |
| description: "Size of the input" | |
| } | |
| ]} | |
| /> | |
| ## Try It | |
| Edit the code below to experiment with the component: | |
| ```tsx live | |
| function Demo() { | |
| return ( | |
| <Input | |
| type="text" | |
| variant="outlined" | |
| /> | |
| ); | |
| } | |
| ``` | |
| ## Props | |
| | Prop | Type | Default | Description | | |
| |------|------|---------|-------------| | |
| | `allowClear` | `boolean` | `false` | - | | |
| | `disabled` | `boolean` | `false` | - | | |
| | `showCount` | `boolean` | `false` | - | | |
| | `type` | `string` | `"text"` | HTML input type | | |
| | `variant` | `string` | `"outlined"` | Input style variant | | |
| ## Import | |
| ```tsx | |
| import { Input } 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/Input/Input.stories.tsx). | |
| ::: | |