@veeqo/ui 5.0.0 → 5.1.0

package/dist/components/Button/components/styled.d.ts

@@ -5,7 +5,7 @@ interface ButtonDisplayProps {
     hasDropdown: boolean;
 }
 export declare const MainContent: import("styled-components").StyledComponent<"span", any, {
-    loading?: boolean | undefined;
+    $loading?: boolean | undefined;
     hasText: boolean;
     size: 'base' | 'md';
 }, never>;

package/dist/components/ShortcutKeys/ShortcutKeys.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import { ShortcutKeysProps } from './types';
+/**
+ * ShortcutKeys UI component
+ *
+ * Renders a keyboard shortcut string by splitting it on "+" and rendering each
+ * key to a <kbd> component.
+ *
+ * Criteria for `shortcut` prop:
+ * - ValidModifierKeys MUST always come before other keys e.g. `shift+a` is valid, `a+shift` is invalid
+ * - If it's not a modifier key it must be a singular key e.g. `a`, `2` is valid and `a2` or `abcde` is invalid etc.
+ * - A limit of 3 key combinations separated between the '+' symbol e.g. `shift+ctrl+a` is valid, `shift+ctrl+a+b` is invalid
+ *
+ */
+export declare const ShortcutKeys: ({ shortcut, label, inverse, displayLabel, ...props }: ShortcutKeysProps) => React.JSX.Element;

package/dist/components/ShortcutKeys/ShortcutKeys.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/ShortcutKeys/index.d.ts

@@ -0,0 +1 @@
+export { ShortcutKeys } from './ShortcutKeys';

package/dist/components/ShortcutKeys/styled.d.ts

@@ -0,0 +1,3 @@
+import { ShortcutKeysContainerProps } from './types';
+export declare const ShortcutKeysContainer: import("styled-components").StyledComponent<"div", any, ShortcutKeysContainerProps, never>;
+export declare const Kbd: import("styled-components").StyledComponent<"kbd", any, {}, never>;

package/dist/components/ShortcutKeys/types.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+export type ShortcutKeysContainerProps = {
+    $inverse?: boolean;
+};
+export type ValidKeys = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '!' | '@' | '#' | '$' | '%' | '^' | '&' | '*' | '(' | ')' | '`' | '-' | '=' | '[' | ']' | '{' | '}' | '?';
+export type ValidModifierKeys = 'command' | 'windows' | 'shift' | 'ctrl' | 'option' | 'alt' | 'enter' | 'delete' | 'escape' | 'up' | 'right' | 'down' | 'left' | 'space';
+export type ShortcutPatterns = `${ValidKeys}` | `${ValidModifierKeys}` | `${ValidKeys}+${ValidKeys}` | `${ValidModifierKeys}+${ValidKeys}` | `${ValidModifierKeys}+${ValidKeys}+${ValidKeys}` | `${ValidModifierKeys}+${ValidModifierKeys}` | `${ValidModifierKeys}+${ValidModifierKeys}+${ValidKeys}`;
+export interface ShortcutKeysProps extends React.HtmlHTMLAttributes<HTMLElement> {
+    shortcut: ShortcutPatterns;
+    label: string;
+    inverse?: boolean;
+    displayLabel?: boolean;
+}
+export type ShortcutAction = {
+    label: string;
+    mac: ShortcutPatterns;
+    windows: ShortcutPatterns;
+};

package/dist/components/ShortcutKeys/utils.d.ts

@@ -0,0 +1,4 @@
+import { ValidModifierKeys, ShortcutAction } from './types';
+export declare const ValidModifierKeysMap: Record<ValidModifierKeys, string>;
+export declare const ValidModifierKeyssLabelMap: Record<ValidModifierKeys, string>;
+export declare const exampleStorybookShortcutActions: ShortcutAction[];

package/dist/components/index.d.ts

@@ -36,6 +36,7 @@ export { Radio } from './Radio';
 export { Search } from './Search';
 export { SegmentedControl } from './SegmentedControl';
 export { Select } from './Select';
+export { ShortcutKeys } from './ShortcutKeys';
 export { SimpleTable } from './SimpleTable';
 export { Slider } from './Slider';
 export { Stack } from './Stack';