File size: 5,511 Bytes
3804d5d
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
---
title: Loading
sidebar_label: Loading
---

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

# Loading

The Loading component from Superset's UI library.

## Live Example

<StoryWithControls
  component="Loading"
  props={{
  size: "m",
  position: "normal",
  muted: false
}}
  controls={[
  {
    name: "size",
    label: "Size",
    type: "select",
    options: [
      "s",
      "m",
      "l"
    ],
    description: "Size of the spinner: s (40px), m (70px), or l (100px)."
  },
  {
    name: "position",
    label: "Position",
    type: "select",
    options: [
      "normal",
      "floating",
      "inline"
    ],
    description: "Position style: normal (inline flow), floating (overlay), or inline."
  },
  {
    name: "muted",
    label: "Muted",
    type: "boolean",
    description: "Whether to show a muted/subtle version of the spinner."
  }
]}
/>

## Try It

Edit the code below to experiment with the component:

```tsx live
function Demo() {
  return (
    <div>
      {['normal', 'floating', 'inline'].map(position => (
        <div
          key={position}
          style={{
            marginBottom: 40,
            padding: 20,
            border: '1px solid #eee',
            position: 'relative',
            minHeight: 80,
          }}
        >
          <h4 style={{ marginTop: 0 }}>{position}</h4>
          <Loading position={position} size="m" />
        </div>
      ))}
    </div>
  );
}
```

## Size and Opacity Showcase

```tsx live
function SizeShowcase() {
  const sizes = ['s', 'm', 'l'];
  return (
    <div style={{ padding: 20 }}>
      <div style={{ display: 'grid', gridTemplateColumns: 'repeat(4, 1fr)', gap: 20, alignItems: 'center' }}>
        <div><strong>Size</strong></div>
        <div><strong>Normal</strong></div>
        <div><strong>Muted</strong></div>
        <div><strong>Usage</strong></div>
        {sizes.map(size => (
          <React.Fragment key={size}>
            <div style={{ fontWeight: 'bold' }}>
              {size.toUpperCase()} ({size === 's' ? '40px' : size === 'm' ? '70px' : '100px'})
            </div>
            <div style={{ textAlign: 'center', padding: 10, border: '1px solid #eee' }}>
              <Loading size={size} position="normal" />
            </div>
            <div style={{ textAlign: 'center', padding: 10, border: '1px solid #eee' }}>
              <Loading size={size} muted position="normal" />
            </div>
            <div style={{ fontSize: 12, color: '#666' }}>
              {size === 's' && 'Filter bars, inline'}
              {size === 'm' && 'Explore pages'}
              {size === 'l' && 'Full page loading'}
            </div>
          </React.Fragment>
        ))}
      </div>
    </div>
  );
}
```

## Contextual Examples

```tsx live
function ContextualDemo() {
  return (
    <div style={{ padding: 20 }}>
      <h4>Filter Bar (size="s", muted)</h4>
      <div style={{ height: 40, backgroundColor: '#f5f5f5', display: 'flex', alignItems: 'center', padding: '0 10px', gap: 10, marginBottom: 30 }}>
        <span>Filter 1:</span>
        <Loading size="s" muted position="normal" />
        <span>Filter 2:</span>
        <Loading size="s" muted position="normal" />
      </div>

      <h4>Dashboard Grid (size="s", muted)</h4>
      <div style={{ display: 'grid', gridTemplateColumns: 'repeat(3, 1fr)', gap: 10, marginBottom: 30 }}>
        {[1, 2, 3].map(i => (
          <div key={i} style={{ height: 100, backgroundColor: '#fafafa', border: '1px solid #ddd', display: 'flex', alignItems: 'center', justifyContent: 'center' }}>
            <Loading size="s" muted position="normal" />
          </div>
        ))}
      </div>

      <h4>Main Loading (size="l")</h4>
      <div style={{ height: 200, display: 'flex', alignItems: 'center', justifyContent: 'center', border: '2px dashed #ccc' }}>
        <Loading size="l" position="normal" />
      </div>
    </div>
  );
}
```

## Props

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `size` | `string` | `"m"` | Size of the spinner: s (40px), m (70px), or l (100px). |
| `position` | `string` | `"normal"` | Position style: normal (inline flow), floating (overlay), or inline. |
| `muted` | `boolean` | `false` | Whether to show a muted/subtle version of the spinner. |

## Import

```tsx
import { Loading } from '@superset-ui/core/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/Loading/Loading.stories.tsx).
:::