mirror of
https://github.com/apache/superset.git
synced 2026-05-22 16:25:49 +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.
141 lines
3.1 KiB
Plaintext
141 lines
3.1 KiB
Plaintext
---
|
|
title: Avatar
|
|
sidebar_label: Avatar
|
|
---
|
|
|
|
<!--
|
|
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';
|
|
|
|
# Avatar
|
|
|
|
The Avatar component from Superset's UI library.
|
|
|
|
## Live Example
|
|
|
|
<StoryWithControls
|
|
component="Avatar"
|
|
props={{
|
|
children: "AB",
|
|
alt: "",
|
|
gap: 4,
|
|
shape: "circle",
|
|
size: "default",
|
|
src: "",
|
|
draggable: false
|
|
}}
|
|
controls={[
|
|
{
|
|
name: "children",
|
|
label: "Children",
|
|
type: "text",
|
|
description: "Text or initials to display inside the avatar."
|
|
},
|
|
{
|
|
name: "alt",
|
|
label: "Alt",
|
|
type: "text"
|
|
},
|
|
{
|
|
name: "gap",
|
|
label: "Gap",
|
|
type: "number",
|
|
description: "Letter spacing inside the avatar."
|
|
},
|
|
{
|
|
name: "shape",
|
|
label: "Shape",
|
|
type: "select",
|
|
options: [
|
|
"circle",
|
|
"square"
|
|
],
|
|
description: "The shape of the avatar."
|
|
},
|
|
{
|
|
name: "size",
|
|
label: "Size",
|
|
type: "select",
|
|
options: [
|
|
"small",
|
|
"default",
|
|
"large"
|
|
],
|
|
description: "The size of the avatar."
|
|
},
|
|
{
|
|
name: "src",
|
|
label: "Src",
|
|
type: "text",
|
|
description: "Image URL for the avatar. If provided, overrides children."
|
|
},
|
|
{
|
|
name: "draggable",
|
|
label: "Draggable",
|
|
type: "boolean"
|
|
}
|
|
]}
|
|
/>
|
|
|
|
## Try It
|
|
|
|
Edit the code below to experiment with the component:
|
|
|
|
```tsx live
|
|
function Demo() {
|
|
return (
|
|
<Avatar
|
|
alt=""
|
|
gap={4}
|
|
shape="circle"
|
|
size="default"
|
|
src=""
|
|
>
|
|
AB
|
|
</Avatar>
|
|
);
|
|
}
|
|
```
|
|
|
|
## Props
|
|
|
|
| Prop | Type | Default | Description |
|
|
|------|------|---------|-------------|
|
|
| `children` | `string` | `"AB"` | Text or initials to display inside the avatar. |
|
|
| `alt` | `string` | `""` | - |
|
|
| `gap` | `number` | `4` | Letter spacing inside the avatar. |
|
|
| `shape` | `string` | `"circle"` | The shape of the avatar. |
|
|
| `size` | `string` | `"default"` | The size of the avatar. |
|
|
| `src` | `string` | `""` | Image URL for the avatar. If provided, overrides children. |
|
|
| `draggable` | `boolean` | `false` | - |
|
|
|
|
## Import
|
|
|
|
```tsx
|
|
import { Avatar } 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/Avatar/Avatar.stories.tsx).
|
|
:::
|