@esrf/daiquiri-lib 0.0.2-alpha.8 → 0.2.0

package/README.md

@@ -0,0 +1,7 @@
+# @esrf/daiquiri-lib
+
+Shared UI components and associated machinary from the [daiquiri-ui](https://gitlab.esrf.fr/ui/daiquiri-ui) project for beamline control and data acquisition. These shared components allow for a consistent look and feel for projects outside of the [daiquiri](https://ui.gitlab-pages.esrf.fr/daiquiri-landing/) core.
+
+The library currently exports the YAML layout language, validator, and renderer, and a selection of hardware components.
+
+See our [documentation](https://ui.gitlab-pages.esrf.fr/daiquiri-ui/daiquiri-lib) for more information.

package/dist/index.d.ts

@@ -229,7 +229,7 @@ declare function Property(props: HardwareWidgetProps<GenericSchema, PropertyWidg
 
 declare function ShutterDefault(props: HardwareWidgetProps<ShutterSchema, HardwareWidgetOptions>): JSX.Element;
 
-interface Props$5 {
+interface Props$b {
     online: boolean;
     activeMessage?: string;
     inactiveMessage?: string;
@@ -237,9 +237,9 @@ interface Props$5 {
     icon: string;
     name: string;
 }
-declare function TypeIcon(props: Props$5): JSX.Element;
+declare function TypeIcon(props: Props$b): JSX.Element;
 
-interface Props$4 {
+interface Props$a {
     hardware: Hardware;
     headerMode?: string;
     widgetIcon: ReactElement;
@@ -250,7 +250,7 @@ interface Props$4 {
  * Normalized way to compose hardware component in order to provide the same
  * kind of layout
  */
-declare function HardwareTemplate(props: Props$4): JSX.Element;
+declare function HardwareTemplate(props: Props$a): JSX.Element;
 
 /**
  * Input number synchronized with a hardware.
@@ -367,12 +367,12 @@ declare class HardwareVariant extends Component<HardwareVariantOptions, void> {
     render(): JSX.Element;
 }
 
-interface Props$3 {
+interface Props$9 {
     className?: string;
 }
-declare function FullSizer(props: PropsWithChildren<Props$3>): JSX.Element;
+declare function FullSizer(props: PropsWithChildren<Props$9>): JSX.Element;
 
-interface Props$2 {
+interface Props$8 {
     step?: number;
     steps?: number[];
     disabled: boolean;
@@ -394,7 +394,7 @@ interface Props$2 {
     }) => void;
     onKeyDown?: (e: KeyboardEvent<HTMLInputElement>) => void;
 }
-declare const NumericStep: react.ForwardRefExoticComponent<Props$2 & react.RefAttributes<HTMLInputElement>>;
+declare const NumericStep: react.ForwardRefExoticComponent<Props$8 & react.RefAttributes<HTMLInputElement>>;
 
 interface YamlNode {
     type: string;
@@ -409,14 +409,131 @@ interface YamlRoot extends YamlNode {
 interface AnyYamlNode extends YamlNode {
     [key: string]: any;
 }
-interface YamlComponent {
+interface YamlComponent$1 {
     providers?: Record<string, any>;
     yamlNode: YamlNode;
     [option: string]: unknown;
 }
 
+interface Props$7 {
+    yamlNode: AnyYamlNode;
+    panel: boolean;
+}
+declare function YamlRow({ yamlNode, panel }: Props$7): JSX.Element;
+
+interface Props$6 {
+    yamlNode: AnyYamlNode;
+    panel: boolean;
+}
+declare function YamlCol({ yamlNode, panel }: Props$6): JSX.Element;
+
 declare function registerComponent(name: string, component: React.ComponentType<any>): void;
+interface YamlComponentNode extends YamlNode {
+    type: string;
+    [name: string]: any;
+    scroll?: boolean;
+    style?: Record<string, any>;
+    title?: string;
+}
+declare function YamlComponent(props: {
+    yamlNode: YamlComponentNode;
+    panel: boolean;
+}): JSX.Element;
+
+interface Props$5 {
+    yamlNode: {
+        children: any[];
+        options?: Record<string, any>;
+    };
+    panel: boolean;
+}
+declare function YamlContainer({ yamlNode, panel }: Props$5): JSX.Element;
+
+interface Props$4 {
+    yamlNode: {
+        children: any[];
+        options?: Record<string, any>;
+        title?: string;
+    };
+    panel: boolean;
+}
+declare function YamlPanel(props: Props$4): ReactElement;
+
+interface Props$3 {
+    yamlNode: {
+        children: any[];
+        options?: Record<string, any>;
+        title: string;
+    };
+    panel: boolean;
+}
+declare function YamlTabs({ yamlNode, panel }: Props$3): JSX.Element;
+
+interface YamlFormHeaderNode extends YamlNode {
+    type: 'formheader';
+    title?: string;
+}
+interface YamlFormRowNode extends YamlNode {
+    type: string;
+    title: string;
+    component?: string;
+    stateinheader?: boolean;
+    titlealign?: string;
+    id?: string;
+    variant?: string;
+    options?: Record<string, any>;
+    even: boolean;
+}
+interface YamlFormNode extends YamlNode {
+    children: (YamlFormHeaderNode | YamlFormRowNode)[];
+    title?: string;
+    [key: string]: any;
+}
+declare function YamlForm(props: {
+    yamlNode: YamlFormNode;
+    panel: boolean;
+}): JSX.Element;
+
+interface YamlGridNode extends YamlNode {
+    children: YamlGridCellNode[];
+    title?: string;
+    columns?: string;
+    rows?: string;
+}
+interface YamlGridCellNode extends YamlNode {
+    columnSpan?: number;
+    rowSpan?: number;
+}
+declare function YamlGrid(props: {
+    yamlNode: YamlGridNode;
+    panel: boolean;
+}): JSX.Element;
 
+interface Props$2 {
+    yamlNode: {
+        children: any[];
+        options?: {
+            [name: string]: any;
+            scroll?: boolean;
+            style?: Record<string, any>;
+        };
+        label?: string;
+    };
+    panel: boolean;
+}
+declare function YamlLabel({ yamlNode, panel }: Props$2): JSX.Element;
+
+declare const yamlMap: {
+    row: typeof YamlRow;
+    col: typeof YamlCol;
+    container: typeof YamlContainer;
+    component: typeof YamlComponent;
+    panel: typeof YamlPanel;
+    tabs: typeof YamlTabs;
+    form: typeof YamlForm;
+    grid: typeof YamlGrid;
+    label: typeof YamlLabel;
+};
 interface Props$1 {
     id: string;
     layout: YamlRoot;
@@ -535,4 +652,31 @@ declare namespace HardwareObject_d {
  */
 declare function registerHardwareComponent(name: string, component: React.ComponentType<any>): void;
 
-export { formatting_d as Formatting, Frontend, FullSizer, HardwareObject_d as HWObject, HardwareInputNumber, HardwareNumericStep, schema_d as HardwareSchema, State_d as HardwareState, HardwareTemplate, types_d as HardwareTypes, HardwareVariant, Info, KeyError, MissingKeysError, MotorDefault, type MotorDefaultOptions, Multiposition, NoObject, NumericStep, Property, ShutterDefault, TypeIcon, ErrorBoundary as YAMLErrorBoundary, Main as YAMLLayout, asserts_d as YamlAsserts, type YamlComponent, type YamlNode, registerHardwareComponent, registerComponent as registerYamlComponent, registerYamlType, renderYamlNode };
+interface Monitor {
+    name: string;
+    type?: string;
+    value: string;
+    overlay?: string;
+    comparator?: string;
+    comparison?: any;
+    unit?: string;
+}
+
+declare function registerRuntimeHook(name: string, hook: (id: string | null) => Hardware | null): void;
+declare const dynamicOp: (op: string, a1: any, b1: any) => boolean | undefined;
+declare function MonitorHardware(props: {
+    monitor: Monitor;
+}): JSX.Element;
+
+declare function registerMonitorComponent(name: string, component: React.ComponentType<any>): void;
+interface MonitorPanelProps {
+    monitors: Monitor[];
+    margin?: 'start' | null;
+    bg?: 'light' | null;
+}
+declare function MonitorPanel(props: MonitorPanelProps): JSX.Element;
+interface MonitorPanelItemProps {
+}
+declare function MonitorPanelItem(props: PropsWithChildren<MonitorPanelItemProps>): JSX.Element;
+
+export { formatting_d as Formatting, Frontend, FullSizer, HardwareObject_d as HWObject, HardwareInputNumber, HardwareNumericStep, schema_d as HardwareSchema, State_d as HardwareState, HardwareTemplate, types_d as HardwareTypes, HardwareVariant, Info, type InfoOptions, KeyError, MissingKeysError, type Monitor, MonitorHardware, MonitorPanel, MonitorPanelItem, type MonitorPanelProps, MotorDefault, type MotorDefaultOptions, Multiposition, NoObject, NumericStep, Property, ShutterDefault, TypeIcon, type Props$b as TypeIconOptions, ErrorBoundary as YAMLErrorBoundary, Main as YAMLLayout, asserts_d as YamlAsserts, type YamlComponent$1 as YamlComponent, type YamlNode, dynamicOp, registerHardwareComponent, registerMonitorComponent, registerRuntimeHook, registerComponent as registerYamlComponent, registerYamlType, renderYamlNode, yamlMap };