mirror of
https://github.com/apache/superset.git
synced 2026-04-07 18:35:15 +00:00
97 lines
2.3 KiB
Plaintext
97 lines
2.3 KiB
Plaintext
---
|
|
title: FaveStar
|
|
sidebar_label: FaveStar
|
|
---
|
|
|
|
<!--
|
|
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';
|
|
|
|
# FaveStar
|
|
|
|
FaveStar component for marking items as favorites
|
|
|
|
## Live Example
|
|
|
|
<StoryWithControls
|
|
component="FaveStar"
|
|
props={{
|
|
itemId: 1,
|
|
isStarred: false,
|
|
showTooltip: true
|
|
}}
|
|
controls={[
|
|
{
|
|
name: "itemId",
|
|
label: "Item ID",
|
|
type: "number",
|
|
description: "Unique identifier for the item"
|
|
},
|
|
{
|
|
name: "isStarred",
|
|
label: "Is Starred",
|
|
type: "boolean",
|
|
description: "Whether the item is currently starred."
|
|
},
|
|
{
|
|
name: "showTooltip",
|
|
label: "Show Tooltip",
|
|
type: "boolean",
|
|
description: "Show tooltip on hover."
|
|
}
|
|
]}
|
|
/>
|
|
|
|
## Try It
|
|
|
|
Edit the code below to experiment with the component:
|
|
|
|
```tsx live
|
|
function Demo() {
|
|
return (
|
|
<FaveStar
|
|
itemId={1}
|
|
showTooltip
|
|
/>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
|------|------|---------|-------------|
|
|
| `itemId` | `number` | `1` | Unique identifier for the item |
|
|
| `isStarred` | `boolean` | `false` | Whether the item is currently starred. |
|
|
| `showTooltip` | `boolean` | `true` | Show tooltip on hover. |
|
|
|
|
## Import
|
|
|
|
```tsx
|
|
import { FaveStar } 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](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-ui-core/src/components/FaveStar/FaveStar.stories.tsx).
|
|
:::
|