Skip to content
ReferenceVersion 6.0.2

Components ​

Import shared components from @ray-template/ui or use subpaths such as /table-pro and /barcode. Inside Ray Admin you can also use @/components. The route transition lives in @ray-template/admin-shell, and the application supplies current route and cache state. This reference lists props, slots, and events the template adds, overrides, or uses. For inherited functionality, consult the types in the pinned Naive UI dependency.

ComponentProps typePurpose
RTableProTableProPropsBare tables, remote queries, automatic height, column settings, export, and optional printing
RFormFormPropsForm loading, validation, reset, and keyboard submission
RModalModalPropsControlled modal, preset widths, and fullscreen cards
RChartChartPropsECharts initialization, themes, and export
RFlowFlowPropsLogicFlow diagrams and read-only mode
RCollapseGridCollapseGridPropsCollapsible filters with action columns
RSegmentSegmentPropsSegmented options, icons, and tooltips
RMoreDropdownMoreDropdownPropsIcon menus and row actions
RIframeIframePropsEmbedded pages with loading state
RBarcodeBarcodePropsCanvas and SVG barcodes
RDraggableCardDefaultPosition (position type)Draggable card and movement boundaries
RTransitionComponentTransitionComponentPropsRoute transitions and KeepAlive
RIconIconPropsTyped SVG sprites

Import App Components and Providers by file. These use template state, themes, or routing. QR codes use vue3-next-qrcode directly.

Each component directory contains its implementation, styles, and types. Prop definitions such as formProps, modalProps, and chartProps also have named exports. Application code normally uses the component and public prop types. To get a TablePro instance directly, use a component ref. RForm, RChart, and RFlow use their respective onRegister contracts.

Public exports · Component conventions · Example source