ContextQMD
Back to Superset

EditableTitle

docs/developer_docs/components/ui/editabletitle.mdx

2021.41.04.7 KB
Original Source
<!-- 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
function Demo() {
  return (
    <EditableTitle
      title="My Dashboard"
      canEdit
      showTooltip
      certifiedBy="Data Team"
      certificationDetails="Verified Q1 2024"
      onSaveTitle={(newTitle) => console.log('Saved:', newTitle)}
    />
  );
}

Props

PropTypeDefaultDescription
canEditbooleantrueWhether the title can be edited.
editingbooleanfalseWhether the title is currently in edit mode.
emptyTextstring"Empty text"Text to display when title is empty.
noPermitTooltipstring"Not permitted"Tooltip shown when user lacks edit permission.
showTooltipbooleantrueWhether to show tooltip on hover.
titlestring"Title"The title text to display.
defaultTitlestring"Default title"Default title when none is provided.
placeholderstring"Placeholder"Placeholder text when editing.
certifiedBystring""Name of person/team who certified this item.
certificationDetailsstring""Additional certification details or description.
maxWidthnumber100Maximum width of the title in pixels.
autoSizebooleantrueWhether to auto-size based on content.

Import

tsx
import { EditableTitle } from '@superset/components';

:::tip[Improve this page] This documentation is auto-generated from the component's Storybook story. Help improve it by editing the story file. :::