Abstract Design System
Version 4.3 by Vincent Massol on 2026/01/07 15:19
Content
Reference
See below the exhaustive list of the User Interface (UI) Elements currently supported by the Abstract Design System (ADS).
All Design System (DS) implementations are expected to comply exhaustively with that definition.
import { ButtonHTMLAttributes } from 'vue';
import { ComponentOptionsMixin } from 'vue';
import { ComputedOptions } from 'vue';
import { DefineComponent } from 'vue';
import { DocumentReference } from '@xwiki/platform-model-api';
import { FormHTMLAttributes } from 'vue';
import { HTMLAttributes } from 'vue';
import { ImgHTMLAttributes } from 'vue';
import { InputHTMLAttributes } from 'vue';
import { MethodOptions } from 'vue';
import { NavigationTreeNode } from '@xwiki/platform-navigation-tree-api';
import { SpaceReference } from '@xwiki/platform-model-api';
import { TreeNode } from '@xwiki/platform-fn-utils';
// @beta
export type AbstractElements = {
XAlert: DefineComponent<AlertProps & HTMLAttributes, object, object, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {
"update:modelValue": (open: boolean) => never;
}>;
XAvatar: DefineComponent<AvatarProps & HTMLAttributes>;
XBtn: DefineComponent<BtnProps & ButtonHTMLAttributes>;
XBreadcrumb: DefineComponent<BreadcrumbProps & HTMLAttributes>;
XCard: DefineComponent<CardProps & HTMLAttributes>;
XCheckbox: DefineComponent<CheckboxProps & HTMLAttributes>;
XDialog: DefineComponent<DialogProps & HTMLAttributes>;
XDivider: DefineComponent<DividerProps & HTMLAttributes>;
XFileInput: DefineComponent<FileInputProps & InputHTMLAttributes>;
XForm: DefineComponent<FormProps & FormHTMLAttributes>;
XImg: DefineComponent<ImgProps & ImgHTMLAttributes>;
XLoad: DefineComponent<LoadProps & HTMLAttributes>;
XMenu: DefineComponent<MenuProps & HTMLAttributes>;
XMenuItem: DefineComponent<MenuItemProps & HTMLAttributes>;
XMenuLabel: DefineComponent<MenuLabelProps & HTMLAttributes>;
XNavigationTree: DefineComponent<NavigationTreeProps & HTMLAttributes>;
XNavigationTreeSelect: DefineComponent<NavigationTreeSelectProps & HTMLAttributes>;
XSelect: DefineComponent<SelectProps & HTMLAttributes>;
XTab: DefineComponent<TabProps & HTMLAttributes>;
XTabGroup: DefineComponent<HTMLAttributes & TabGroupProps>;
XTabPanel: DefineComponent<TabPanelProps & HTMLAttributes>;
XTextField: DefineComponent<TextFieldProps & ImgHTMLAttributes>;
XTree: DefineComponent<TreeProps & HTMLAttributes>;
};
// @beta
export type AlertActions = AlterAction[];
// @beta
export type AlertProps = {
title?: string;
type: "success" | "warning" | "error" | "info";
description?: string;
actions?: AlertActions;
closable?: boolean;
details?: string;
flatCorners?: boolean;
};
// @beta
export type AlterAction = {
name: string;
callback: () => void;
};
// @beta
export type AvatarProps = {
image?: string;
size?: string;
name?: string;
};
// @beta
export type BreadcrumbItem = {
label: string;
url?: string;
};
// @beta
export type BreadcrumbItems = BreadcrumbItem[];
// @beta
export type BreadcrumbProps = {
items: BreadcrumbItems;
};
// @beta
export type BtnProps = {
variant?: "default" | "primary" | "success" | "neutral" | "warning" | "danger" | "text";
size?: "small";
pill?: boolean;
};
// @beta
export type CardProps = {
title?: string;
};
// @beta
export type CheckboxProps = {
label: string;
help?: string;
modelValue?: boolean;
};
// @beta
export type DialogProps = {
width?: "auto";
modelValue?: boolean;
logo?: string;
};
// @beta
export type DisplayableTreeNode = TreeNode<{
id: string;
label: string;
url?: string;
activatable?: boolean;
}>;
// @beta
export type DividerProps = unknown;
// @beta
export type FileInputModel = File | File[] | null | undefined;
// @beta
export type FileInputProps = {
modelValue: FileInputModel;
label: string;
};
// @beta
export type FormProps = {
onFormSubmit?: () => void;
};
// @beta
export type ImgProps = unknown;
// @beta
export type LoadProps = unknown;
// @beta
export type MenuItemProps = {
value: string;
disabled?: boolean;
};
// @beta
export type MenuLabelProps = unknown;
// @beta
export type MenuProps = {
disabled?: boolean;
};
// @beta
export type NavigationTreeProps = {
clickAction?: (node: NavigationTreeNode) => void;
currentPageReference?: DocumentReference;
includeTerminals?: boolean;
showRootNode?: boolean;
};
// @beta
export const navigationTreePropsDefaults: {
includeTerminals: boolean;
};
// @beta
export type NavigationTreeSelectProps = {
label: string;
help?: string;
currentPageReference?: DocumentReference;
modelValue?: SpaceReference;
includeTerminals?: boolean;
};
// @beta
export const navigationTreeSelectPropsDefaults: {
includeTerminals: boolean;
};
// @beta
export type SelectProps = {
label: string;
items: Array<string>;
help?: string;
required?: boolean;
modelValue?: string;
};
// @beta
export type TabGroupProps = {
onTabChange: (tabId: string) => void;
};
// @beta
export type TabPanelProps = {
tabId: string;
};
// @beta
export type TabProps = {
tabId: string;
};
// @beta
export type TextFieldProps = {
name?: string;
label: string;
required?: boolean;
autofocus?: boolean;
modelValue?: string;
help?: string;
readonly?: boolean;
type?: "date" | "datetime-local" | "email" | "number" | "password" | "search" | "tel" | "text" | "time" | "url";
};
// @beta
export type TreeProps = {
rootNode: DisplayableTreeNode;
showRootNode?: boolean;
activated?: string;
opened?: string[];
};