mirror of
https://github.com/apache/superset.git
synced 2026-04-25 11:04:48 +00:00
0fb7fc2721
Major restructuring of documentation to separate concerns: **New Structure:** - `/docs/` - User-facing docs (intro, quickstart, databases, using-superset, faq) - `/admin-docs/` - Administrator docs (installation, configuration, security) - `/developer-docs/` - Developer docs (contributing, extensions, guidelines, testing) **Changes:** - Move installation, configuration, and security docs to admin_docs/ - Move contributing, extensions, guidelines, and testing to developer_docs/ - Rename developer_portal to developer_docs (with underscore to hyphen in URL) - Add sidebarAdminDocs.js for admin documentation navigation - Update versions-config.json with new doc sections - Update docusaurus.config.ts with new plugins and redirects - Update internal links in versioned docs (6.0.0) to use new paths - Keep user-facing content (databases, using-superset, faq) in main docs This separation makes it clearer which documentation is relevant for: - End users exploring and visualizing data - Administrators deploying and configuring Superset - Developers contributing to or extending Superset Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
133 lines
3.8 KiB
Plaintext
133 lines
3.8 KiB
Plaintext
---
|
|
title: ListViewCard
|
|
sidebar_label: ListViewCard
|
|
---
|
|
|
|
<!--
|
|
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';
|
|
|
|
# ListViewCard
|
|
|
|
ListViewCard is a card component used to display items in list views with an image, title, description, and optional cover sections.
|
|
|
|
## Live Example
|
|
|
|
<StoryWithControls
|
|
component="ListViewCard"
|
|
props={{
|
|
title: "Superset Card Title",
|
|
loading: false,
|
|
url: "/superset/dashboard/births/",
|
|
imgURL: "https://picsum.photos/seed/superset/300/200",
|
|
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
|
|
coverLeft: "Left Section",
|
|
coverRight: "Right Section"
|
|
}}
|
|
controls={[
|
|
{
|
|
name: "title",
|
|
label: "Title",
|
|
type: "text",
|
|
description: "Title displayed on the card."
|
|
},
|
|
{
|
|
name: "loading",
|
|
label: "Loading",
|
|
type: "boolean",
|
|
description: "Whether the card is in loading state."
|
|
},
|
|
{
|
|
name: "url",
|
|
label: "URL",
|
|
type: "text",
|
|
description: "URL the card links to."
|
|
},
|
|
{
|
|
name: "imgURL",
|
|
label: "Image URL",
|
|
type: "text",
|
|
description: "Primary image URL for the card."
|
|
},
|
|
{
|
|
name: "description",
|
|
label: "Description",
|
|
type: "text",
|
|
description: "Description text displayed on the card."
|
|
},
|
|
{
|
|
name: "coverLeft",
|
|
label: "Cover Left",
|
|
type: "text",
|
|
description: "Content for the left section of the cover."
|
|
},
|
|
{
|
|
name: "coverRight",
|
|
label: "Cover Right",
|
|
type: "text",
|
|
description: "Content for the right section of the cover."
|
|
}
|
|
]}
|
|
/>
|
|
|
|
## Try It
|
|
|
|
Edit the code below to experiment with the component:
|
|
|
|
```tsx live
|
|
function Demo() {
|
|
return (
|
|
<ListViewCard
|
|
title="Superset Card Title"
|
|
url="/superset/dashboard/births/"
|
|
imgURL="https://picsum.photos/seed/superset/300/200"
|
|
description="Lorem ipsum dolor sit amet, consectetur adipiscing elit..."
|
|
coverLeft="Left Section"
|
|
coverRight="Right Section"
|
|
/>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
|------|------|---------|-------------|
|
|
| `title` | `string` | `"Superset Card Title"` | Title displayed on the card. |
|
|
| `loading` | `boolean` | `false` | Whether the card is in loading state. |
|
|
| `url` | `string` | `"/superset/dashboard/births/"` | URL the card links to. |
|
|
| `imgURL` | `string` | `"https://picsum.photos/seed/superset/300/200"` | Primary image URL for the card. |
|
|
| `description` | `string` | `"Lorem ipsum dolor sit amet, consectetur adipiscing elit..."` | Description text displayed on the card. |
|
|
| `coverLeft` | `string` | `"Left Section"` | Content for the left section of the cover. |
|
|
| `coverRight` | `string` | `"Right Section"` | Content for the right section of the cover. |
|
|
|
|
## Import
|
|
|
|
```tsx
|
|
import { ListViewCard } 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/ListViewCard/ListViewCard.stories.tsx).
|
|
:::
|