@ramme-io/ui 1.1.1 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/dist/blocks/ai/Actions.d.ts +4 -0
  2. package/dist/blocks/ai/ChatFAB.d.ts +1 -0
  3. package/dist/blocks/ai/Conversation.d.ts +1 -0
  4. package/dist/blocks/ai/Loader.d.ts +1 -0
  5. package/dist/blocks/ai/Message.d.ts +1 -0
  6. package/dist/blocks/ai/PromptInput.d.ts +1 -0
  7. package/dist/blocks/iot/DeviceCard.d.ts +1 -0
  8. package/dist/component-registry.d.ts +3 -0
  9. package/dist/components/data-display/ActivityFeed.d.ts +1 -0
  10. package/dist/components/data-display/BarChart.d.ts +1 -0
  11. package/dist/components/data-display/ChartWithTable.d.ts +1 -0
  12. package/dist/components/data-display/CodeBlock.d.ts +1 -0
  13. package/dist/components/data-display/DataTable.d.ts +1 -0
  14. package/dist/components/data-display/LineChart.d.ts +1 -0
  15. package/dist/components/data-display/PieChart.d.ts +1 -0
  16. package/dist/components/data-display/StatCard.d.ts +1 -0
  17. package/dist/components/data-display/StatusBadge.d.ts +1 -0
  18. package/dist/components/data-display/Table.d.ts +1 -0
  19. package/dist/components/feedback/Alert.d.ts +1 -0
  20. package/dist/components/feedback/EmptyState.d.ts +1 -0
  21. package/dist/components/feedback/TippyTooltip.d.ts +1 -0
  22. package/dist/components/feedback/Toast.d.ts +1 -0
  23. package/dist/components/feedback/ToastProvider.d.ts +4 -0
  24. package/dist/components/forms/ButtonGroup.d.ts +1 -0
  25. package/dist/components/forms/Checkbox.d.ts +1 -0
  26. package/dist/components/forms/ComboBox.d.ts +1 -0
  27. package/dist/components/forms/DatePicker.d.ts +1 -0
  28. package/dist/components/forms/FileUpload.d.ts +1 -0
  29. package/dist/components/forms/FormTemplate.d.ts +1 -0
  30. package/dist/components/forms/Input.d.ts +1 -0
  31. package/dist/components/forms/MultiSelect.d.ts +1 -0
  32. package/dist/components/forms/Radio.d.ts +1 -0
  33. package/dist/components/forms/SearchInput.d.ts +1 -0
  34. package/dist/components/forms/SegmentedControl.d.ts +1 -0
  35. package/dist/components/forms/Select.d.ts +1 -0
  36. package/dist/components/forms/Textarea.d.ts +1 -0
  37. package/dist/components/forms/ToggleSwitch.d.ts +1 -0
  38. package/dist/components/layout/Accordion.d.ts +4 -0
  39. package/dist/components/layout/ActionBar.d.ts +1 -0
  40. package/dist/components/layout/Card.d.ts +1 -0
  41. package/dist/components/layout/Drawer.d.ts +1 -0
  42. package/dist/components/layout/List.d.ts +13 -0
  43. package/dist/components/layout/Modal.d.ts +1 -0
  44. package/dist/components/layout/PageHeader.d.ts +1 -0
  45. package/dist/components/layout/SectionHeader.d.ts +1 -0
  46. package/dist/components/layout/Sidebar.d.ts +1 -0
  47. package/dist/components/navigation/Breadcrumbs.d.ts +4 -0
  48. package/dist/components/navigation/Menu.d.ts +7 -0
  49. package/dist/components/navigation/Pagination.d.ts +1 -0
  50. package/dist/components/navigation/Stepper.d.ts +1 -0
  51. package/dist/components/navigation/Tabs.d.ts +4 -0
  52. package/dist/components/ui/Avatar.d.ts +1 -0
  53. package/dist/components/ui/Badge.d.ts +1 -0
  54. package/dist/components/ui/Button.d.ts +1 -0
  55. package/dist/components/ui/icon-loader.d.ts +1 -1
  56. package/dist/data/mockData.d.ts +4 -0
  57. package/dist/index.es.js +1954 -1937
  58. package/dist/index.umd.js +1690 -1690
  59. package/dist/style.css +1 -1
  60. package/package.json +9 -5
@@ -10,6 +10,10 @@ import { default as React } from 'react';
10
10
  * type: () => void
11
11
  * description: Function to call when the suggestion is clicked.
12
12
  * @category ai
13
+ * @id suggestion
14
+ * @id actions
15
+ * @id actions
16
+ * @id actions
13
17
  */
14
18
  export declare const Suggestion: React.FC<{
15
19
  children: React.ReactNode;
@@ -22,5 +22,6 @@ export interface ChatFABProps {
22
22
  * description: The text content for the button's tooltip.
23
23
  * default: 'Open AI Assistant'
24
24
  * @category ui
25
+ * @id chat-fab
25
26
  */
26
27
  export declare const ChatFAB: React.FC<ChatFABProps>;
@@ -6,6 +6,7 @@ import { default as React } from 'react';
6
6
  * @description A container component that holds a series of Message components and manages the layout and scrolling of the chat history.
7
7
  * @tags ui, ai, layout, chat
8
8
  * @category ai
9
+ * @id conversation
9
10
  */
10
11
  export declare const Conversation: React.FC<{
11
12
  children: React.ReactNode;
@@ -6,5 +6,6 @@ import { default as React } from 'react';
6
6
  * @description A visual indicator used within an AI Message to show that a response is being generated.
7
7
  * @tags ui, ai, feedback, loading
8
8
  * @category ai
9
+ * @id loader
9
10
  */
10
11
  export declare const Loader: React.FC;
@@ -33,5 +33,6 @@ export interface MessageProps {
33
33
  * type: (suggestion: string) => void
34
34
  * description: Callback for when a suggestion is clicked.
35
35
  * @category ai
36
+ * @id message
36
37
  */
37
38
  export declare const Message: React.FC<MessageProps>;
@@ -26,5 +26,6 @@ export interface PromptInputProps {
26
26
  * description: Placeholder text for the input field.
27
27
  * default: "Type your message..."
28
28
  * @category ai
29
+ * @id prompt-input
29
30
  */
30
31
  export declare const PromptInput: React.FC<PromptInputProps>;
@@ -41,6 +41,7 @@ export type DeviceStatus = keyof typeof statusColorMap;
41
41
  * - name: className
42
42
  * type: string
43
43
  * description: Optional additional CSS classes.
44
+ * @id device-card
44
45
  */
45
46
  export interface DeviceCardProps {
46
47
  title: string;
@@ -0,0 +1,3 @@
1
+ import { default as React } from 'react';
2
+
3
+ export declare const AUTO_REGISTRY: Record<string, React.FC<any>>;
@@ -31,5 +31,6 @@ export interface ActivityFeedProps {
31
31
  * type: string
32
32
  * description: An optional URL for a "View changelog" link.
33
33
  * @category templates-patterns
34
+ * @id activity-feed
34
35
  */
35
36
  export declare const ActivityFeed: React.FC<ActivityFeedProps>;
@@ -24,5 +24,6 @@ export interface BarChartProps {
24
24
  * type: string
25
25
  * description: An optional title to display above the chart.
26
26
  * @category charts
27
+ * @id bar-chart
27
28
  */
28
29
  export declare const BarChart: React.FC<BarChartProps>;
@@ -30,5 +30,6 @@ export interface ChartWithTableProps {
30
30
  * type: TableHeader[]
31
31
  * description: The column definitions for the table view.
32
32
  * @category templates-patterns
33
+ * @id chart-with-table
33
34
  */
34
35
  export declare const ChartWithTable: React.FC<ChartWithTableProps>;
@@ -18,6 +18,7 @@ interface CodeBlockProps {
18
18
  * type: string
19
19
  * description: The programming language for syntax highlighting (e.g., 'tsx', 'css', 'javascript').
20
20
  * @category ui
21
+ * @id code-block
21
22
  */
22
23
  export declare const CodeBlock: React.FC<CodeBlockProps>;
23
24
  export {};
@@ -27,5 +27,6 @@ export interface DataTableProps extends AgGridReactProps {
27
27
  * type: GridOptions
28
28
  * description: Additional AG Grid options to configure the grid's behavior.
29
29
  * @category data-display
30
+ * @id data-table
30
31
  */
31
32
  export declare const DataTable: React.FC<DataTableProps>;
@@ -15,5 +15,6 @@ export interface LineChartProps {
15
15
  * @description A theme-aware line chart component...
16
16
  * @tags charts, data-visualization, rechart
17
17
  * @category charts
18
+ * @id line-chart
18
19
  */
19
20
  export declare const LineChart: React.FC<LineChartProps>;
@@ -11,5 +11,6 @@ export interface PieChartProps {
11
11
  * @description A theme-aware pie chart component powered by Recharts, for showing proportional relationships of parts to a whole.
12
12
  * @tags charts, data-visualization, rechart
13
13
  * @category charts
14
+ * @id pie-chart
14
15
  */
15
16
  export declare const PieChart: React.FC<PieChartProps>;
@@ -38,5 +38,6 @@ export interface StatCardProps {
38
38
  * type: string
39
39
  * description: Optional additional CSS classes for custom styling.
40
40
  * @category templates-patterns
41
+ * @id stat-card
41
42
  */
42
43
  export declare const StatCard: React.FC<StatCardProps>;
@@ -31,5 +31,6 @@ export interface StatusBadgeProps {
31
31
  * - name: className
32
32
  * type: string
33
33
  * description: Additional CSS classes.
34
+ * @id status-badge
34
35
  */
35
36
  export declare const StatusBadge: React.FC<StatusBadgeProps>;
@@ -30,5 +30,6 @@ export interface TableProps {
30
30
  * type: string
31
31
  * description: Optional additional CSS classes for custom styling of the table container.
32
32
  * @category data-display
33
+ * @id table
33
34
  */
34
35
  export declare const Table: React.FC<TableProps>;
@@ -26,5 +26,6 @@ export interface AlertProps {
26
26
  * type: string
27
27
  * description: Optional additional CSS classes for custom styling of the alert container.
28
28
  * @category feedback
29
+ * @id alert
29
30
  */
30
31
  export declare const Alert: React.FC<AlertProps>;
@@ -39,6 +39,7 @@ interface EmptyStateProps {
39
39
  * type: string
40
40
  * description: Additional CSS classes for custom styling of the container.
41
41
  * @category feedback
42
+ * @id empty-state
42
43
  */
43
44
  export declare const EmptyState: React.FC<EmptyStateProps>;
44
45
  export {};
@@ -25,5 +25,6 @@ import { TippyProps } from '@tippyjs/react';
25
25
  * type: string
26
26
  * description: Optional additional CSS classes for custom styling of the tooltip content.
27
27
  * @category feedback
28
+ * @id tippy-tooltip
28
29
  */
29
30
  export declare const TippyTooltip: React.FC<TippyProps>;
@@ -36,5 +36,6 @@ export interface ToastProps {
36
36
  * type: (id: string) => void
37
37
  * description: Callback function triggered when the toast is dismissed.
38
38
  * @category feedback
39
+ * @id toast
39
40
  */
40
41
  export declare const Toast: React.FC<ToastProps>;
@@ -18,6 +18,10 @@ interface ToastContextType {
18
18
  * type: (id: string) => void
19
19
  * description: A function to programmatically dismiss a toast by its ID.
20
20
  * @category feedback
21
+ * @id use-toast
22
+ * @id toast-provider
23
+ * @id toast-provider
24
+ * @id toast-provider
21
25
  */
22
26
  export declare const useToast: () => ToastContextType;
23
27
  /**
@@ -46,5 +46,6 @@ export interface ButtonGroupProps {
46
46
  * type: (value: string | number) => void
47
47
  * description: Callback function for segmented controls, called when the selected value changes.
48
48
  * @category form
49
+ * @id button-group
49
50
  */
50
51
  export declare const ButtonGroup: React.FC<ButtonGroupProps>;
@@ -28,5 +28,6 @@ export interface CheckboxProps extends React.InputHTMLAttributes<HTMLInputElemen
28
28
  * type: string
29
29
  * description: Optional additional CSS classes for the input element.
30
30
  * @category form
31
+ * @id checkbox
31
32
  */
32
33
  export declare const Checkbox: React.FC<CheckboxProps>;
@@ -18,6 +18,7 @@ interface ComboBoxProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>
18
18
  * @description A text input with an integrated dropdown list of selectable options, allowing both typing and selection.
19
19
  * @tags form, input, select, dropdown, autocomplete, ui
20
20
  * @category form
21
+ * @id combo-box
21
22
  */
22
23
  export declare const ComboBox: React.FC<ComboBoxProps>;
23
24
  export {};
@@ -49,5 +49,6 @@ export interface DatePickerProps {
49
49
  * type: Date
50
50
  * description: The latest selectable date.
51
51
  * @category form
52
+ * @id date-picker
52
53
  */
53
54
  export declare const DatePicker: React.FC<DatePickerProps>;
@@ -30,6 +30,7 @@ interface FileUploadProps {
30
30
  * type: string
31
31
  * description: Optional additional CSS classes for custom styling of the file upload container.
32
32
  * @category form
33
+ * @id file-upload
33
34
  */
34
35
  export declare const FileUpload: React.FC<FileUploadProps>;
35
36
  export {};
@@ -84,6 +84,7 @@ export interface FormTemplateProps {
84
84
  * - name: children
85
85
  * type: React.ReactNode
86
86
  * description: Content to render at the bottom of the form, typically used for action buttons like "Save" or "Cancel".
87
+ * @id form-template
87
88
  */
88
89
  export declare const FormTemplate: React.FC<FormTemplateProps>;
89
90
  export {};
@@ -41,5 +41,6 @@ export interface InputProps extends React.InputHTMLAttributes<HTMLInputElement>
41
41
  * - name: containerClassName
42
42
  * type: string
43
43
  * description: Optional additional CSS classes for the container.
44
+ * @id input
44
45
  */
45
46
  export declare const Input: React.ForwardRefExoticComponent<InputProps & React.RefAttributes<HTMLInputElement>>;
@@ -21,5 +21,6 @@ export interface MultiSelectProps {
21
21
  * @description An enhanced dropdown that allows users to select multiple options from a searchable list.
22
22
  * @tags form, input, select, dropdown
23
23
  * @category form
24
+ * @id multi-select
24
25
  */
25
26
  export declare const MultiSelect: React.FC<MultiSelectProps>;
@@ -34,5 +34,6 @@ export interface RadioProps extends React.InputHTMLAttributes<HTMLInputElement>
34
34
  * type: string
35
35
  * description: Optional additional CSS classes for the input element.
36
36
  * @category form
37
+ * @id radio
37
38
  */
38
39
  export declare const Radio: React.FC<RadioProps>;
@@ -7,5 +7,6 @@ import { InputProps } from './Input';
7
7
  * @description A specialized input for search functionality, using the base Input component with a search icon.
8
8
  * @tags form, input, search, ui
9
9
  * @category form
10
+ * @id search-input
10
11
  */
11
12
  export declare const SearchInput: React.FC<InputProps>;
@@ -35,5 +35,6 @@ export interface SegmentedControlProps {
35
35
  * - name: className
36
36
  * type: string
37
37
  * description: Additional CSS classes.
38
+ * @id segmented-control
38
39
  */
39
40
  export declare const SegmentedControl: React.FC<SegmentedControlProps>;
@@ -36,5 +36,6 @@ export interface SelectProps extends React.SelectHTMLAttributes<HTMLSelectElemen
36
36
  * type: boolean
37
37
  * description: If true, the select dropdown will be unclickable.
38
38
  * @category form
39
+ * @id select
39
40
  */
40
41
  export declare const Select: React.FC<SelectProps>;
@@ -17,6 +17,7 @@ interface TextareaProps extends React.TextareaHTMLAttributes<HTMLTextAreaElement
17
17
  * type: string
18
18
  * description: Optional additional CSS classes for the container div.
19
19
  * @category form
20
+ * @id textarea
20
21
  */
21
22
  export declare const Textarea: React.ForwardRefExoticComponent<TextareaProps & React.RefAttributes<HTMLTextAreaElement>>;
22
23
  export {};
@@ -35,5 +35,6 @@ export interface ToggleSwitchProps {
35
35
  * description: If true, the toggle will be unclickable and styled as disabled.
36
36
  * default: false
37
37
  * @category form
38
+ * @id toggle-switch
38
39
  */
39
40
  export declare const ToggleSwitch: React.FC<ToggleSwitchProps>;
@@ -29,6 +29,10 @@ interface AccordionItemProps {
29
29
  * type: (id: string, isOpen: boolean) => void
30
30
  * description: Callback triggered when the item is toggled, providing its `id` and new `isOpen` state.
31
31
  * @category layout
32
+ * @id accordion-item
33
+ * @id accordion
34
+ * @id accordion
35
+ * @id accordion
32
36
  */
33
37
  declare const AccordionItem: React.FC<AccordionItemProps>;
34
38
  interface AccordionProps {
@@ -19,5 +19,6 @@ export interface ActionBarProps {
19
19
  * type: string
20
20
  * description: Optional additional CSS classes for custom styling of the action bar container.
21
21
  * @category layout
22
+ * @id action-bar
22
23
  */
23
24
  export declare const ActionBar: React.FC<ActionBarProps>;
@@ -13,5 +13,6 @@ import { HTMLAttributes, FC } from 'react';
13
13
  * type: string
14
14
  * description: Optional additional CSS classes for custom styling. Use this for adding padding, shadows, etc. (e.g., 'p-4 shadow-lg').
15
15
  * @category layout
16
+ * @id card
16
17
  */
17
18
  export declare const Card: FC<HTMLAttributes<HTMLDivElement>>;
@@ -16,5 +16,6 @@ export interface DrawerProps {
16
16
  * @description A sliding panel that appears from the edge of the screen, used for additional content or forms.
17
17
  * @tags layout, modal, slide-in, ui
18
18
  * @category layout
19
+ * @id drawer
19
20
  */
20
21
  export declare const Drawer: React.FC<DrawerProps>;
@@ -15,6 +15,19 @@ interface ListItemProps extends React.LiHTMLAttributes<HTMLLIElement> {
15
15
  * type: string
16
16
  * description: Optional additional CSS classes for the list item (`<li>`).
17
17
  * @category layout
18
+ * @id list-item
19
+ * @id list
20
+ * @id definition-term
21
+ * @id definition-description
22
+ * @id definition-list
23
+ * @id list
24
+ * @id definition-term
25
+ * @id definition-description
26
+ * @id definition-list
27
+ * @id list
28
+ * @id definition-term
29
+ * @id definition-description
30
+ * @id definition-list
18
31
  */
19
32
  declare const ListItem: React.FC<ListItemProps>;
20
33
  interface ListProps extends React.HTMLAttributes<HTMLUListElement | HTMLOListElement> {
@@ -14,6 +14,7 @@ interface ModalProps {
14
14
  * @description A dialog box that appears on top of the current page, requiring user interaction to dismiss.
15
15
  * @tags ui, overlay, dialog, popup
16
16
  * @category layout
17
+ * @id modal
17
18
  */
18
19
  export declare const Modal: React.FC<ModalProps>;
19
20
  export {};
@@ -29,5 +29,6 @@ export interface PageHeaderProps {
29
29
  * type: string
30
30
  * description: Optional additional CSS classes for custom styling of the page header container.
31
31
  * @category templates-patterns
32
+ * @id page-header
32
33
  */
33
34
  export declare const PageHeader: React.FC<PageHeaderProps>;
@@ -19,5 +19,6 @@ export interface SectionHeaderProps {
19
19
  * type: string
20
20
  * description: Optional additional CSS classes for custom styling of the header container.
21
21
  * @category templates-patterns
22
+ * @id section-header
22
23
  */
23
24
  export declare const SectionHeader: React.FC<SectionHeaderProps>;
@@ -15,6 +15,7 @@ export declare const SidebarProvider: ({ children }: {
15
15
  * @description A collapsible, responsive sidebar component.
16
16
  * @props
17
17
  * @prop {React.ReactNode} children - The content of the sidebar.
18
+ * @id sidebar
18
19
  */
19
20
  export declare const Sidebar: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
20
21
  export declare const SidebarHeader: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
@@ -29,6 +29,10 @@ interface BreadcrumbItemProps {
29
29
  * type: string
30
30
  * description: Additional CSS classes for custom styling of the individual item.
31
31
  * @category navigation
32
+ * @id breadcrumb-item
33
+ * @id breadcrumbs
34
+ * @id breadcrumbs
35
+ * @id breadcrumbs
32
36
  */
33
37
  declare const BreadcrumbItem: React.FC<BreadcrumbItemProps>;
34
38
  interface BreadcrumbsProps {
@@ -4,6 +4,13 @@ import { default as React } from 'react';
4
4
  * @wizard
5
5
  * @name MenuDivider
6
6
  * @description A visual separator for grouping MenuItems within a Menu.
7
+ * @id menu-divider
8
+ * @id menu-item
9
+ * @id menu
10
+ * @id menu-item
11
+ * @id menu
12
+ * @id menu-item
13
+ * @id menu
7
14
  */
8
15
  declare const MenuDivider: React.FC;
9
16
  interface MenuItemProps {
@@ -35,5 +35,6 @@ export interface PaginationProps {
35
35
  * type: string
36
36
  * description: Optional additional CSS classes for the container.
37
37
  * @category navigation
38
+ * @id pagination
38
39
  */
39
40
  export declare const Pagination: React.FC<PaginationProps>;
@@ -32,5 +32,6 @@ export interface StepperProps {
32
32
  * type: string
33
33
  * description: Optional additional CSS classes for the stepper container.
34
34
  * @category navigation
35
+ * @id stepper
35
36
  */
36
37
  export declare const Stepper: React.FC<StepperProps>;
@@ -25,6 +25,10 @@ export interface TabPanelProps {
25
25
  * type: React.ReactNode
26
26
  * description: An optional icon to display next to the tab label in the header.
27
27
  * @category navigation
28
+ * @id tab-panel
29
+ * @id tabs
30
+ * @id tabs
31
+ * @id tabs
28
32
  */
29
33
  export declare const TabPanel: React.FC<TabPanelProps>;
30
34
  export interface TabsProps {
@@ -34,6 +34,7 @@ interface AvatarProps {
34
34
  * type: string
35
35
  * description: Optional additional CSS classes for custom styling.
36
36
  * @category ui
37
+ * @id avatar
37
38
  */
38
39
  export declare const Avatar: React.FC<AvatarProps>;
39
40
  export {};
@@ -19,6 +19,7 @@ export interface BadgeProps extends React.HTMLAttributes<HTMLDivElement>, Varian
19
19
  * type: React.ReactNode
20
20
  * description: The content to display inside the badge.
21
21
  * @category ui
22
+ * @id badge
22
23
  */
23
24
  declare function Badge({ className, variant, ...props }: BadgeProps): import("react/jsx-runtime").JSX.Element;
24
25
  export { Badge, badgeVariants };
@@ -29,6 +29,7 @@ import { IconName } from './Icon';
29
29
  * - name: onClick
30
30
  * type: () => void
31
31
  * description: Callback fired when the button is clicked.
32
+ * @id button
32
33
  */
33
34
  declare const buttonVariants: (props?: ({
34
35
  variant?: "link" | "ghost" | "primary" | "danger" | "outline" | "secondary" | "accent" | null | undefined;