mirror of
https://github.com/apache/superset.git
synced 2026-05-22 00:05:15 +00:00
cbcfd9599f
Snapshots all four versioned Docusaurus sections at v6.1.0. Built on top of the version-cutting tooling work in chore/docs-cut-6.1.0-versions so the snapshot benefits from: - Auto-gen refresh before snapshotting (database pages from engine spec metadata, API reference from openapi.json, component pages from Storybook stories) — captured at the SHA we cut from rather than whatever happened to be on disk. - Data-import freeze: country list, feature flag table, database diagnostics, and component metadata are copied into snapshot-local `_versioned_data/` dirs so the historical version doesn't silently mutate when the source files change. - Depth-aware import-path rewriter that handles deeply-nested component MDX files referencing `../../../src/` from the snapshot. Versioning behavior: `lastVersion` stays at `current` for every section, so the canonical URLs (`/docs/...`, `/admin-docs/...`, `/developer-docs/...`, `/components/...`) continue to render content from master. The `current` version is consistently labeled "Next" with an `unreleased` banner, and `6.1.0` is a historical pin accessible only via its explicit version segment. Component playground: previously `disabled: true` in versions-config.json, now enabled and versioned. The plugin block in docusaurus.config.ts was already gated only by the `disabled` flag, so no other code changes were needed to bring it back online. The frozen `databases.json` in the snapshot is the canonical 80-database artifact from the latest committed state in master (preserved by the generator's input-hash cache), not a fallback regenerated from a local Flask environment.
114 lines
3.5 KiB
Markdown
114 lines
3.5 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
---
|
|
title: Grid
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# Grid Component
|
|
|
|
The Grid component provides a flexible layout system for arranging content in rows and columns.
|
|
|
|
## Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
|------|------|---------|-------------|
|
|
| `gutter` | `number` or `[number, number]` | `0` | Grid spacing between items, can be a single number or [horizontal, vertical] |
|
|
| `columns` | `number` | `12` | Number of columns in the grid |
|
|
| `justify` | `string` | `'start'` | Horizontal alignment: 'start', 'center', 'end', 'space-between', 'space-around' |
|
|
| `align` | `string` | `'top'` | Vertical alignment: 'top', 'middle', 'bottom' |
|
|
| `wrap` | `boolean` | `true` | Whether to wrap items when they overflow |
|
|
|
|
### Row Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
|------|------|---------|-------------|
|
|
| `gutter` | `number` or `[number, number]` | `0` | Spacing between items in the row |
|
|
| `justify` | `string` | `'start'` | Horizontal alignment for this row |
|
|
| `align` | `string` | `'top'` | Vertical alignment for this row |
|
|
|
|
### Col Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
|------|------|---------|-------------|
|
|
| `span` | `number` | - | Number of columns the grid item spans |
|
|
| `offset` | `number` | `0` | Number of columns the grid item is offset |
|
|
| `xs`, `sm`, `md`, `lg`, `xl` | `number` or `object` | - | Responsive props for different screen sizes |
|
|
|
|
## Examples
|
|
|
|
### Basic Grid
|
|
|
|
```jsx
|
|
import { Grid, Row, Col } from '@superset-ui/core';
|
|
|
|
function Example() {
|
|
return (
|
|
<Grid>
|
|
<Row gutter={16}>
|
|
<Col span={8}>
|
|
<div>Column 1</div>
|
|
</Col>
|
|
<Col span={8}>
|
|
<div>Column 2</div>
|
|
</Col>
|
|
<Col span={8}>
|
|
<div>Column 3</div>
|
|
</Col>
|
|
</Row>
|
|
</Grid>
|
|
);
|
|
}
|
|
```
|
|
|
|
### Responsive Grid
|
|
|
|
```jsx
|
|
import { Grid, Row, Col } from '@superset-ui/core';
|
|
|
|
function Example() {
|
|
return (
|
|
<Grid>
|
|
<Row gutter={[16, 24]}>
|
|
<Col xs={24} sm={12} md={8} lg={6}>
|
|
<div>Responsive Column 1</div>
|
|
</Col>
|
|
<Col xs={24} sm={12} md={8} lg={6}>
|
|
<div>Responsive Column 2</div>
|
|
</Col>
|
|
<Col xs={24} sm={12} md={8} lg={6}>
|
|
<div>Responsive Column 3</div>
|
|
</Col>
|
|
<Col xs={24} sm={12} md={8} lg={6}>
|
|
<div>Responsive Column 4</div>
|
|
</Col>
|
|
</Row>
|
|
</Grid>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Best Practices
|
|
|
|
- Use the Grid system for complex layouts that need to be responsive
|
|
- Specify column widths for different screen sizes to ensure proper responsive behavior
|
|
- Use gutters to create appropriate spacing between grid items
|
|
- Keep the grid structure consistent throughout your application
|
|
- Consider using the grid system for dashboard layouts to ensure consistent spacing and alignment
|