---
title: List
sidebar_label: List
---

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

# List

The List component from Superset's UI library.

## Live Example

<StoryWithControls
  component="List"
  props={{
  bordered: false,
  split: true,
  size: "default",
  loading: false,
  dataSource: [
    "Dashboard Analytics",
    "User Management",
    "Data Sources"
  ]
}}
  controls={[
  {
    name: "bordered",
    label: "Bordered",
    type: "boolean",
    description: "Whether to show a border around the list."
  },
  {
    name: "split",
    label: "Split",
    type: "boolean",
    description: "Whether to show a divider between items."
  },
  {
    name: "size",
    label: "Size",
    type: "select",
    options: [
      "default",
      "small",
      "large"
    ],
    description: "Size of the list."
  },
  {
    name: "loading",
    label: "Loading",
    type: "boolean",
    description: "Whether to show a loading indicator."
  }
]}
/>

## Try It

Edit the code below to experiment with the component:

```tsx live
function Demo() {
  const data = ['Dashboard Analytics', 'User Management', 'Data Sources'];
  return (
    <List
      bordered
      dataSource={data}
      renderItem={(item) => <List.Item>{item}</List.Item>}
    />
  );
}
```

## Props

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `bordered` | `boolean` | `false` | Whether to show a border around the list. |
| `split` | `boolean` | `true` | Whether to show a divider between items. |
| `size` | `string` | `"default"` | Size of the list. |
| `loading` | `boolean` | `false` | Whether to show a loading indicator. |
| `dataSource` | `any` | `["Dashboard Analytics","User Management","Data Sources"]` | - |

## Import

```tsx
import { List } 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/List/List.stories.tsx).
:::