mirror of
https://github.com/apache/superset.git
synced 2026-05-07 17:04:58 +00:00
752ebd47cb
- Snapshot all four versioned docs sections at v6.1.0; master continues to serve as "Next" (lastVersion: current, banner: unreleased) so editing master keeps updating the canonical URLs - Enable the previously-disabled components plugin and version it - Rename stale "developer_portal" references to "developer_docs" across package.json scripts, manage-versions.mjs, theme files (DocVersionBadge, DocVersionBanner), DOCS_CLAUDE.md, and README.md (URL backward-compat redirect /developer_portal/* preserved) - Add admin_docs version scripts; drop dead "tutorials" plugin id from the version badge - Generalize fixVersionedImports in manage-versions.mjs to walk every section's snapshot and rewrite ../../src/ and ../../data/ imports, catching admin_docs and components files that previous version cuts would have broken - Remove orphan files: developer_portal_versions.json, tutorials_versions.json, and stray empty versions.json files inside components/ and developer_docs/ content directories
60 lines
2.2 KiB
Markdown
60 lines
2.2 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: Component Library
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# Superset Component Library
|
|
|
|
Welcome to the Apache Superset Component Library documentation. This section provides comprehensive documentation for all the UI components, chart components, and layout components used in Superset.
|
|
|
|
## What is the Component Library?
|
|
|
|
The Component Library is a collection of reusable UI components that are used to build the Superset user interface. These components are designed to be consistent, accessible, and easy to use.
|
|
|
|
## Component Categories
|
|
|
|
The Component Library is organized into the following categories:
|
|
|
|
### UI Components
|
|
|
|
Basic UI components like buttons, inputs, dropdowns, and other form elements.
|
|
|
|
### Chart Components
|
|
|
|
Visualization components used to render different types of charts and graphs.
|
|
|
|
### Layout Components
|
|
|
|
Components used for page layout, such as containers, grids, and navigation elements.
|
|
|
|
## Versioning
|
|
|
|
The Component Library documentation follows its own versioning scheme, independent from the main Superset documentation. This allows us to update the component documentation as the components evolve, without affecting the main documentation.
|
|
|
|
## Getting Started
|
|
|
|
Browse the sidebar to explore the different components available in the library. Each component documentation includes:
|
|
|
|
- Component description and purpose
|
|
- Props and configuration options
|
|
- Usage examples
|
|
- Best practices
|