ContextQMD
Back to Superset

ListViewCard

docs/developer_docs/components/ui/listviewcard.mdx

2021.41.03.8 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';

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
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

PropTypeDefaultDescription
titlestring"Superset Card Title"Title displayed on the card.
loadingbooleanfalseWhether the card is in loading state.
urlstring"/superset/dashboard/births/"URL the card links to.
imgURLstring"https://picsum.photos/seed/superset/300/200"Primary image URL for the card.
descriptionstring"Lorem ipsum dolor sit amet, consectetur adipiscing elit..."Description text displayed on the card.
coverLeftstring"Left Section"Content for the left section of the cover.
coverRightstring"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. :::