UNPKG

@thebase/ui

Version:

CDN-installable Owl and Bootstrap 5 UI component library.

73 lines (44 loc) • 1.99 kB
# Avatar Use `b-ui="avatar"` for a CDN-ready avatar component. ## CDN install requirements Load the pinned BaseUI CSS and JavaScript files; no extra dependency is required for this component. ## Pure Owl component ```js import { Avatar } from "@thebase/ui"; ``` ```base-ui <div style="max-width: 28rem"> <Avatar src="'https://github.com/shadcn.png'" alt="'shadcn'"> <t t-set-slot="fallback">CN</t> </Avatar> </div> ``` | Component | Prop | Type | Notes | | --- | --- | --- | --- | | `Avatar` | `src` | `String` | optional | | `Avatar` | `alt` | `String` | optional | | `Avatar` | `title` | `String` | optional, native hover tooltip | | `Avatar` | `className` | `String` | optional | See [Pure Owl Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`. ## Static component ```base-ui <div b-ui="avatar">Avatar</div> ``` ## Enhanced usage Call `BaseUI.mount(element)` or rely on `BaseUI.mountAll()` after the script loads. ## Options and attributes See `dist/baseui.registry.json` for the supported attribute list. ## Methods Use the global runtime methods: `BaseUI.mount()`, `BaseUI.mountAll()`, and `BaseUI.destroy()`. ## Events Interactive components emit documented `baseui:*` events from their root element. Static components do not emit events. ## CSS variables The component inherits BaseUI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`. ## Accessibility behavior The component preserves authored semantic HTML and adds ARIA roles or state attributes where enhancement is required. ## Examples See `examples/index.html` for a working CDN-style page. ## Browser support BaseUI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3. ## Test checklist Verify light and dark themes, keyboard access for focusable controls, disabled or readonly states when applicable, and cleanup through `BaseUI.destroy()`.