| --- |
| title: Space |
| sidebar_label: Space |
| --- |
| |
| <!-- |
| 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'; |
| |
| # Space |
| |
| The Space component from Superset's UI library. |
| |
| ## Live Example |
| |
| <StoryWithControls |
| component="Space" |
| props={{ |
| direction: "horizontal", |
| size: "small", |
| wrap: false |
| }} |
| controls={[ |
| { |
| name: "direction", |
| label: "Direction", |
| type: "select", |
| options: [ |
| "vertical", |
| "horizontal" |
| ] |
| }, |
| { |
| name: "size", |
| label: "Size", |
| type: "select", |
| options: [ |
| "small", |
| "middle", |
| "large" |
| ] |
| }, |
| { |
| name: "wrap", |
| label: "Wrap", |
| type: "boolean" |
| }, |
| { |
| name: "align", |
| label: "Align", |
| type: "select", |
| options: [ |
| "start", |
| "end", |
| "center", |
| "baseline" |
| ] |
| } |
| ]} |
| sampleChildren={["Item 1","Item 2","Item 3","Item 4","Item 5"]} |
| sampleChildrenStyle={{padding:"8px 16px",background:"#e6f4ff",border:"1px solid #91caff",borderRadius:"4px"}} |
| /> |
| |
| ## Try It |
| |
| Edit the code below to experiment with the component: |
| |
| ```tsx live |
| function Demo() { |
| return ( |
| <Space size="small"> |
| {['Item 1', 'Item 2', 'Item 3', 'Item 4', 'Item 5'].map(item => ( |
| <div |
| key={item} |
| style={{ |
| padding: '8px 16px', |
| background: '#e6f4ff', |
| border: '1px solid #91caff', |
| borderRadius: 4, |
| }} |
| > |
| {item} |
| </div> |
| ))} |
| </Space> |
| ); |
| } |
| ``` |
| |
| ## Vertical Space |
| |
| ```tsx live |
| function VerticalSpace() { |
| return ( |
| <Space direction="vertical" size="middle" style={{ display: 'flex' }}> |
| <Button buttonStyle="primary">Primary</Button> |
| <Button buttonStyle="secondary">Secondary</Button> |
| <Button buttonStyle="dashed">Dashed</Button> |
| </Space> |
| ); |
| } |
| ``` |
| |
| ## Space Sizes |
| |
| ```tsx live |
| function SpaceSizes() { |
| const items = ['Item 1', 'Item 2', 'Item 3']; |
| const itemStyle = { |
| padding: '8px 16px', |
| background: '#e6f4ff', |
| border: '1px solid #91caff', |
| borderRadius: 4, |
| }; |
| return ( |
| <div style={{ display: 'flex', flexDirection: 'column', gap: 24 }}> |
| {['small', 'middle', 'large'].map(size => ( |
| <div key={size}> |
| <h4>{size}</h4> |
| <Space size={size}> |
| {items.map(item => ( |
| <div key={item} style={itemStyle}>{item}</div> |
| ))} |
| </Space> |
| </div> |
| ))} |
| </div> |
| ); |
| } |
| ``` |
| |
| ## Props |
| |
| | Prop | Type | Default | Description | |
| |------|------|---------|-------------| |
| | `direction` | `string` | `"horizontal"` | - | |
| | `size` | `string` | `"small"` | - | |
| | `wrap` | `boolean` | `false` | - | |
| |
| ## Import |
| |
| ```tsx |
| import { Space } 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/Space/Space.stories.tsx). |
| ::: |