mirror of
https://github.com/apache/superset.git
synced 2026-05-22 08:15:36 +00:00
04451766e7
Previously docusaurus.config.ts had `onBrokenLinks: 'warn'`, so broken
internal links produced advisory warnings during build but didn't gate
merges. Tightening to `throw` surfaces every broken internal route at
build time. Three classes of issue fell out:
1. Stale `/docs/...` and `/docs/6.0.0/...` references in the 6.0.0
versioned snapshot. The user-facing docs section was renamed
`docs` → `user-docs` (routeBasePath) at some point after 6.0.0 was
cut, but the snapshot's links still pointed at the old prefix. The
live site redirects /docs/* → /user-docs/* at runtime, but
Docusaurus's onBrokenLinks checker doesn't honor redirects.
Bulk-rewrote /docs/* → /user-docs/* across the snapshot (and one
/docs/api → /developer-docs/api).
2. Bare-relative MDX links like `[Label](./mcp)` (no .md/.mdx
extension). Docusaurus renders an absolute href in SSR HTML, so
static crawlers see correct links — BUT React Router's `<Link>`
component on the client side resolves the bare path relative to
the current URL on click, so when the page URL has a trailing
slash (e.g. /extensions/overview/), `./mcp` becomes
/extensions/overview/mcp (404). This is exactly the broken-flow a
user reported on /developer-docs/extensions/overview/. Added the
`.md`/`.mdx` extension to all 44 such links across 17 files; this
makes Docusaurus resolve them to the canonical doc URL at the
<Link> level, so SPA navigation works regardless of trailing slash.
3. Miscellaneous content fixes:
- 4 `/configuration/feature-flags` references in 6.0.0 snapshot
pointed at a page that doesn't exist in that version (the
dedicated feature-flags page was added later). Repointed to the
`#feature-flags` anchor inside `configuring-superset.mdx`.
- 3 references to `superset-core/src/superset_core/rest_api/decorators.py`
in extensions docs were rendered as relative URLs, resolving to
/developer-docs/extensions/superset-core/... (404). Converted to
absolute GitHub URLs.
- 1 `/storybook/?path=...` link in extensions/components/index.mdx
pointed at a non-existent route. Repointed to the existing
`/developer-docs/testing/storybook` page that explains how to
run Storybook locally.
- 4 unclosed-paren markdown links in 6.0.0 installation-methods.mdx
(pre-existing source bugs).
Build now passes with `onBrokenLinks: 'throw'`. Note that
`onBrokenAnchors` is still `'warn'` (default); a separate effort
should tighten that and fix the surviving anchor warnings (currently
~60 instances of `/community#superset-community-calendar`).
94 lines
2.6 KiB
Plaintext
94 lines
2.6 KiB
Plaintext
---
|
|
title: Extension Components
|
|
sidebar_label: Overview
|
|
sidebar_position: 1
|
|
---
|
|
|
|
<!--
|
|
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.
|
|
-->
|
|
|
|
# Extension Components
|
|
|
|
These UI components are available to Superset extension developers through the `@apache-superset/core/components` package. They provide a consistent look and feel with the rest of Superset and are designed to be used in extension panels, views, and other UI elements.
|
|
|
|
## Available Components
|
|
|
|
- [Alert](./alert.mdx)
|
|
|
|
## Usage
|
|
|
|
All components are exported from the `@apache-superset/core/components` package:
|
|
|
|
```tsx
|
|
import { Alert } from '@apache-superset/core/components';
|
|
|
|
export function MyExtensionPanel() {
|
|
return (
|
|
<Alert type="info">
|
|
Welcome to my extension!
|
|
</Alert>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Adding New Components
|
|
|
|
Components in `@apache-superset/core/components` are automatically documented here. To add a new extension component:
|
|
|
|
1. Add the component to `superset-frontend/packages/superset-core/src/ui/components/`
|
|
2. Export it from `superset-frontend/packages/superset-core/src/ui/components/index.ts`
|
|
3. Create a Storybook story with an `Interactive` export:
|
|
|
|
```tsx
|
|
export default {
|
|
title: 'Extension Components/MyComponent',
|
|
component: MyComponent,
|
|
parameters: {
|
|
docs: {
|
|
description: {
|
|
component: 'Description of the component...',
|
|
},
|
|
},
|
|
},
|
|
};
|
|
|
|
export const InteractiveMyComponent = (args) => <MyComponent {...args} />;
|
|
|
|
InteractiveMyComponent.args = {
|
|
variant: 'primary',
|
|
disabled: false,
|
|
};
|
|
|
|
InteractiveMyComponent.argTypes = {
|
|
variant: {
|
|
control: { type: 'select' },
|
|
options: ['primary', 'secondary'],
|
|
},
|
|
disabled: {
|
|
control: { type: 'boolean' },
|
|
},
|
|
};
|
|
```
|
|
|
|
4. Run `yarn start` in `docs/` - the page generates automatically!
|
|
|
|
## Interactive Documentation
|
|
|
|
For interactive examples with controls, run Storybook locally — see the [Storybook documentation](/developer-docs/testing/storybook).
|