Spaces:
Paused
Paused
File size: 5,517 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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | ---
title: EditableTitle
sidebar_label: EditableTitle
---
<!--
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';
# EditableTitle
The EditableTitle component from Superset's UI library.
## Live Example
<StoryWithControls
component="EditableTitle"
props={{
canEdit: true,
editing: false,
emptyText: 'Empty text',
noPermitTooltip: 'Not permitted',
showTooltip: true,
title: 'Title',
defaultTitle: 'Default title',
placeholder: 'Placeholder',
certifiedBy: '',
certificationDetails: '',
maxWidth: 100,
autoSize: true,
}}
controls={[
{
name: 'canEdit',
label: 'Can Edit',
type: 'boolean',
description: 'Whether the title can be edited.',
},
{
name: 'editing',
label: 'Editing',
type: 'boolean',
description: 'Whether the title is currently in edit mode.',
},
{
name: 'emptyText',
label: 'Empty Text',
type: 'text',
description: 'Text to display when title is empty.',
},
{
name: 'noPermitTooltip',
label: 'No Permit Tooltip',
type: 'text',
description: 'Tooltip shown when user lacks edit permission.',
},
{
name: 'showTooltip',
label: 'Show Tooltip',
type: 'boolean',
description: 'Whether to show tooltip on hover.',
},
{
name: 'title',
label: 'Title',
type: 'text',
description: 'The title text to display.',
},
{
name: 'defaultTitle',
label: 'Default Title',
type: 'text',
description: 'Default title when none is provided.',
},
{
name: 'placeholder',
label: 'Placeholder',
type: 'text',
description: 'Placeholder text when editing.',
},
{
name: 'certifiedBy',
label: 'Certified By',
type: 'text',
description: 'Name of person/team who certified this item.',
},
{
name: 'certificationDetails',
label: 'Certification Details',
type: 'text',
description: 'Additional certification details or description.',
},
{
name: 'maxWidth',
label: 'Max Width',
type: 'number',
description: 'Maximum width of the title in pixels.',
},
{
name: 'autoSize',
label: 'Auto Size',
type: 'boolean',
description: 'Whether to auto-size based on content.',
},
]}
/>
## Try It
Edit the code below to experiment with the component:
```tsx live
function Demo() {
return (
<EditableTitle
title="My Dashboard"
canEdit
showTooltip
certifiedBy="Data Team"
certificationDetails="Verified Q1 2024"
onSaveTitle={newTitle => console.log('Saved:', newTitle)}
/>
);
}
```
## Props
| Prop | Type | Default | Description |
| ---------------------- | --------- | ----------------- | ------------------------------------------------ |
| `canEdit` | `boolean` | `true` | Whether the title can be edited. |
| `editing` | `boolean` | `false` | Whether the title is currently in edit mode. |
| `emptyText` | `string` | `"Empty text"` | Text to display when title is empty. |
| `noPermitTooltip` | `string` | `"Not permitted"` | Tooltip shown when user lacks edit permission. |
| `showTooltip` | `boolean` | `true` | Whether to show tooltip on hover. |
| `title` | `string` | `"Title"` | The title text to display. |
| `defaultTitle` | `string` | `"Default title"` | Default title when none is provided. |
| `placeholder` | `string` | `"Placeholder"` | Placeholder text when editing. |
| `certifiedBy` | `string` | `""` | Name of person/team who certified this item. |
| `certificationDetails` | `string` | `""` | Additional certification details or description. |
| `maxWidth` | `number` | `100` | Maximum width of the title in pixels. |
| `autoSize` | `boolean` | `true` | Whether to auto-size based on content. |
## Import
```tsx
import { EditableTitle } 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/EditableTitle/EditableTitle.stories.tsx).
:::
|