Spaces:
Paused
Paused
File size: 3,526 Bytes
93dd899 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | ---
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).
:::
|