@bolio-ui/core 1.0.4 → 1.0.6

package/esm/Tooltip/stories.js

@@ -0,0 +1,183 @@
+import Tooltip from '.';
+import Grid from '../Grid';
+import Button from '../Button';
+import Link from '../Link';
+import Code from '../Code';
+import Text from '../Text';
+import Badge from '../Badge';
+export default {
+  title: 'Data Display/Tooltip',
+  component: Tooltip
+};
+export var Default = function Default() {
+  return /*#__PURE__*/React.createElement(Grid.Container, {
+    gap: 2
+  }, /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: 'Push to Git and your website is live.'
+  }, "Tooltip")));
+};
+export var Trigger = function Trigger() {
+  return /*#__PURE__*/React.createElement(Grid.Container, {
+    gap: 2
+  }, /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: 'Push to Git and your website is live.',
+    trigger: "click",
+    type: "dark"
+  }, "Click me")));
+};
+export var WithComponents = function WithComponents() {
+  return /*#__PURE__*/React.createElement(Grid.Container, {
+    gap: 2
+  }, /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: 'Push to Git and your website is live.',
+    type: "dark"
+  }, /*#__PURE__*/React.createElement(Button, {
+    auto: true,
+    scale: 1 / 2
+  }, "Button"))), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: 'Push to Git and your website is live.',
+    type: "dark"
+  }, /*#__PURE__*/React.createElement(Badge, null, "1000+"))), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: 'Push to Git and your website is live.',
+    type: "dark"
+  }, /*#__PURE__*/React.createElement(Link, {
+    href: "#",
+    color: true
+  }, "Hyperlink"))));
+};
+export var CustomContent = function CustomContent() {
+  return /*#__PURE__*/React.createElement(Grid.Container, {
+    gap: 2
+  }, /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: /*#__PURE__*/React.createElement(React.Fragment, null, "Perfect for working with a ", /*#__PURE__*/React.createElement(Code, null, "CMS"), ".")
+  }, "Top")), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
+      b: true
+    }, "Perfect"), " for working with a CMS."),
+    placement: "bottom"
+  }, "Bottom")));
+};
+export var Types = function Types() {
+  return /*#__PURE__*/React.createElement(Grid.Container, {
+    gap: 2
+  }, /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: "Perfect for working with a CMS.",
+    type: "dark"
+  }, "Dark")), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: "Perfect for working with a CMS.",
+    type: "success"
+  }, "Success")), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: "Perfect for working with a CMS.",
+    type: "warning"
+  }, "Warning")), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: "Perfect for working with a CMS.",
+    type: "error"
+  }, "Error")), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: "Perfect for working with a CMS.",
+    type: "secondary"
+  }, "Secondary")));
+};
+export var Variants = function Variants() {
+  return /*#__PURE__*/React.createElement(Grid.Container, {
+    gap: 2
+  }, /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: "Push to Git and your website is live.",
+    type: "lite"
+  }, "Lite")), /*#__PURE__*/React.createElement(Grid, null, /*#__PURE__*/React.createElement(Tooltip, {
+    text: "Push to Git and your website is live.",
+    hideArrow: true
+  }, "No Arrow")));
+};
+export var Placements = function Placements() {
+  var text = 'HTTP is stateless, but not sessionless';
+  return /*#__PURE__*/React.createElement(Grid.Container, {
+    gap: 2,
+    justify: "center",
+    alignItems: "center"
+  }, /*#__PURE__*/React.createElement(Grid, {
+    xs: 4,
+    justify: "flex-end"
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "topStart",
+    type: "dark"
+  }, "topStart")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 4,
+    justify: "center"
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "top",
+    type: "dark"
+  }, "top")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 4
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "topEnd",
+    type: "dark"
+  }, "topEnd")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 3,
+    justify: "flex-end"
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "leftStart",
+    type: "dark"
+  }, "leftStart")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 6
+  }), /*#__PURE__*/React.createElement(Grid, {
+    xs: 3
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "rightStart",
+    type: "dark"
+  }, "rightStart")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 3,
+    justify: "flex-end"
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "left",
+    type: "dark"
+  }, "left")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 6
+  }), /*#__PURE__*/React.createElement(Grid, {
+    xs: 3
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "right",
+    type: "dark"
+  }, "right")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 3,
+    justify: "flex-end"
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "leftEnd",
+    type: "dark"
+  }, "leftEnd")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 6
+  }), /*#__PURE__*/React.createElement(Grid, {
+    xs: 3
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "rightEnd",
+    type: "dark"
+  }, "rightEnd")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 4,
+    justify: "flex-end"
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "bottomStart",
+    type: "dark"
+  }, "bottomStart")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 4,
+    justify: "center"
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "bottom",
+    type: "dark"
+  }, "bottom")), /*#__PURE__*/React.createElement(Grid, {
+    xs: 4
+  }, /*#__PURE__*/React.createElement(Tooltip, {
+    text: text,
+    placement: "bottomEnd",
+    type: "dark"
+  }, "bottomEnd")));
+};

package/esm/Tooltip/styles.d.ts

@@ -0,0 +1,7 @@
+import { SnippetTypes } from "../utils/prop-types";
+import { BolioUIThemesPalette } from "../Themes/Presets";
+export declare type TooltipColors = {
+    bgColor: string;
+    color: string;
+};
+export declare const getColors: (type: SnippetTypes, palette: BolioUIThemesPalette) => TooltipColors;

package/esm/index.d.ts

@@ -0,0 +1,125 @@
+export { default as Avatar } from "./Avatar";
+export type { AvatarProps, AvatarGroupProps } from "./Avatar";
+export { default as Badge } from "./Badge";
+export type { BadgeProps, BadgeAnchorProps } from "./Badge";
+export { default as BolioUIProvider } from "./BolioUIProvider";
+export type { BolioUIProviderProps } from "./BolioUIProvider";
+export { default as Breadcrumbs } from "./Breadcrumbs";
+export type { BreadcrumbsProps, BreadcrumbsItemProps, BreadcrumbsSeparatorProps } from "./Breadcrumbs";
+export { default as Button } from "./Button";
+export type { ButtonProps } from "./Button";
+export { default as ButtonDropdown } from "./ButtonDropdown";
+export type { ButtonDropdownProps, ButtonDropdownItemProps } from "./ButtonDropdown";
+export { default as ButtonGroup } from "./ButtonGroup";
+export type { ButtonGroupProps } from "./ButtonGroup";
+export { default as Capacity } from "./Capacity";
+export type { CapacityProps } from "./Capacity";
+export { default as Card } from "./Card";
+export type { CardProps, CardContentProps, CardFooterProps } from "./Card";
+export { default as Checkbox } from "./Checkbox";
+export type { CheckboxProps, CheckboxGroupProps } from "./Checkbox";
+export { default as Code } from "./Code";
+export type { CodeProps } from "./Code";
+export { default as Col } from "./Col";
+export type { ColProps } from "./Col";
+export { default as Collapse } from "./Collapse";
+export type { CollapseProps, CollapseGroupProps } from "./Collapse";
+export { default as Container } from "./Container";
+export type { ContainerProps } from "./Container";
+export { default as Description } from "./Description";
+export type { DescriptionProps } from "./Description";
+export { default as Display } from "./Display";
+export type { DisplayProps } from "./Display";
+export { default as Divider } from "./Divider";
+export type { DividerProps } from "./Divider";
+export { default as Dot } from "./Dot";
+export type { DotProps } from "./Dot";
+export { default as Drawer } from "./Drawer";
+export type { DrawerProps } from "./Drawer";
+export { default as Fieldset } from "./Fieldset";
+export type { FieldsetProps, FieldsetTitleProps, FieldsetSubtitleProps, FieldsetGroupProps, FieldsetFooterProps, FieldsetContentProps } from "./Fieldset";
+export { default as Grid } from "./Grid";
+export type { GridProps, GridContainerProps } from "./Grid";
+export { default as Image } from "./Image";
+export type { ImageProps, ImageBrowserProps } from "./Image";
+export { default as Input } from "./Input";
+export type { InputProps, InputPasswordProps } from "./Input";
+export { default as Keyboard } from "./Keyboard";
+export type { KeyboardProps } from "./Keyboard";
+export { default as Link } from "./Link";
+export type { LinkProps } from "./Link";
+export { default as Loading } from "./Loading";
+export type { LoadingProps } from "./Loading";
+export { default as Modal } from "./Modal";
+export type { ModalProps, ModalTitleProps, ModalSubtitleProps, ModalContentProps, ModalActionProps } from "./Modal";
+export { default as Note } from "./Note";
+export type { NoteProps } from "./Note";
+export { default as Page } from "./Page";
+export type { PageProps, PageHeaderProps, PageContentProps, PageFooterProps } from "./Page";
+export { default as Pagination } from "./Pagination";
+export type { PaginationProps, PaginationNextProps, PaginationPreviousProps } from "./Pagination";
+export { default as Popover } from "./Popover";
+export type { PopoverProps, PopoverItemProps } from "./Popover";
+export { default as Progress } from "./Progress";
+export type { ProgressProps } from "./Progress";
+export { default as Radio } from "./Radio";
+export type { RadioProps, RadioGroupProps, RadioDescriptionProps } from "./Radio";
+export { default as Rating } from "./Rating";
+export type { RatingProps } from "./Rating";
+export { default as Row } from "./Row";
+export type { RowProps } from "./Row";
+export { default as Section } from "./Section";
+export type { SectionProps } from "./Section";
+export { default as Select } from "./Select";
+export type { SelectProps, SelectOptionProps } from "./Select";
+export { default as Slider } from "./Slider";
+export type { SliderProps } from "./Slider";
+export { default as Snippet } from "./Snippet";
+export type { SnippetProps } from "./Snippet";
+export { default as Spacer } from "./Spacer";
+export type { SpacerProps } from "./Spacer";
+export { default as Spinner } from "./Spinner";
+export type { SpinnerProps } from "./Spinner";
+export { default as Table } from "./Table";
+export type { TableProps, TableColumnProps } from "./Table";
+export { default as Tabs } from "./Tabs";
+export type { TabsProps } from "./Tabs";
+export { default as Tag } from "./Tag";
+export type { TagProps } from "./Tag";
+export { default as Text } from "./Text";
+export type { TextProps } from "./Text";
+export { default as Textarea } from "./Textarea";
+export type { TextareaProps } from "./Textarea";
+export { default as Themes } from "./Themes";
+export type { BolioUIThemes, BolioUIUserTheme } from "./Themes";
+export { default as Toggle } from "./Toggle";
+export type { ToggleProps } from "./Toggle";
+export { default as Tooltip } from "./Tooltip";
+export type { TooltipProps } from "./Tooltip";
+export { default as useAllThemes } from "./use-all-themes";
+export type { AllThemesConfig } from "./use-all-themes";
+export { default as useToasts } from "./use-toasts";
+export type { Toast, ToastInput, ToastAction, ToastLayout } from "./use-toasts";
+export { default as useBodyScroll } from "./use-body-scroll";
+export type { BodyScrollOptions } from "./use-body-scroll";
+export { default as useClipboard } from "./use-clipboard";
+export type { UseClipboardOptions } from "./use-clipboard";
+export { default as useMediaQuery } from "./use-media-query";
+export type { ResponsiveOptions, ResponsiveBreakpoint } from "./use-media-query";
+export { default as useKeyboard, KeyMod, KeyCode } from "./use-keyboard";
+export type { KeyboardOptions, UseKeyboardHandler } from "./use-keyboard";
+export { default as useInput } from "./use-input";
+export { default as useModal } from "./use-modal";
+export { default as useTabs } from "./use-tabs";
+export { default as useClickAway } from "./use-click-away";
+export { default as useCurrentState } from "./use-current-state";
+export { default as CssBaseline } from "./CssBaseline";
+export { default as useTheme } from "./use-theme";
+export { default as useClasses } from "./use-classes";
+export { default as useScale } from "./use-scale";
+export { withScale, ScalePropKeys, ScaleContext } from "./use-scale";
+export type { ScaleProps, ScaleConfig, GetScalePropsFunction, GetAllScalePropsFunction } from "./use-scale";
+export { useRect } from "./utils/layouts";
+export type { ReactiveDomReact } from "./utils/layouts";
+export { default as Highlight } from "./Shared/highlight";
+export type { HighlightProps } from "./Shared/highlight";

package/esm/index.js

@@ -1,55 +1,55 @@
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 /// <reference types="styled-jsx" />
-export { default as Avatar } from './avatar';
-export { default as Badge } from './badge';
-export { default as BolioUIProvider } from './bolio-ui-provider';
-export { default as Breadcrumbs } from './breadcrumbs';
-export { default as Button } from './button';
-export { default as ButtonDropdown } from './button-dropdown';
-export { default as ButtonGroup } from './button-group';
-export { default as Capacity } from './capacity';
-export { default as Card } from './card';
-export { default as Checkbox } from './checkbox';
-export { default as Code } from './code';
-export { default as Col } from './col';
-export { default as Collapse } from './collapse';
-export { default as Container } from './container';
-export { default as Description } from './description';
-export { default as Display } from './display';
-export { default as Divider } from './divider';
-export { default as Dot } from './dot';
-export { default as Drawer } from './drawer';
-export { default as Fieldset } from './fieldset';
-export { default as Grid } from './grid';
-export { default as Image } from './image';
-export { default as Input } from './input';
-export { default as Keyboard } from './keyboard';
-export { default as Link } from './link';
-export { default as Loading } from './loading';
-export { default as Modal } from './modal';
-export { default as Note } from './note';
-export { default as Page } from './page';
-export { default as Pagination } from './pagination';
-export { default as Popover } from './popover';
-export { default as Progress } from './progress';
-export { default as Radio } from './radio';
-export { default as Rating } from './rating';
-export { default as Row } from './row';
-export { default as Section } from './section';
-export { default as Select } from './select';
-export { default as Slider } from './slider';
-export { default as Snippet } from './snippet';
-export { default as Spacer } from './spacer';
-export { default as Spinner } from './spinner';
-export { default as Table } from './table';
-export { default as Tabs } from './tabs';
-export { default as Tag } from './tag';
-export { default as Text } from './text';
-export { default as Textarea } from './textarea';
-export { default as Themes } from './themes';
-export { default as Toggle } from './toggle';
-export { default as Tooltip } from './tooltip';
+export { default as Avatar } from './Avatar';
+export { default as Badge } from './Badge';
+export { default as BolioUIProvider } from './BolioUIProvider';
+export { default as Breadcrumbs } from './Breadcrumbs';
+export { default as Button } from './Button';
+export { default as ButtonDropdown } from './ButtonDropdown';
+export { default as ButtonGroup } from './ButtonGroup';
+export { default as Capacity } from './Capacity';
+export { default as Card } from './Card';
+export { default as Checkbox } from './Checkbox';
+export { default as Code } from './Code';
+export { default as Col } from './Col';
+export { default as Collapse } from './Collapse';
+export { default as Container } from './Container';
+export { default as Description } from './Description';
+export { default as Display } from './Display';
+export { default as Divider } from './Divider';
+export { default as Dot } from './Dot';
+export { default as Drawer } from './Drawer';
+export { default as Fieldset } from './Fieldset';
+export { default as Grid } from './Grid';
+export { default as Image } from './Image';
+export { default as Input } from './Input';
+export { default as Keyboard } from './Keyboard';
+export { default as Link } from './Link';
+export { default as Loading } from './Loading';
+export { default as Modal } from './Modal';
+export { default as Note } from './Note';
+export { default as Page } from './Page';
+export { default as Pagination } from './Pagination';
+export { default as Popover } from './Popover';
+export { default as Progress } from './Progress';
+export { default as Radio } from './Radio';
+export { default as Rating } from './Rating';
+export { default as Row } from './Row';
+export { default as Section } from './Section';
+export { default as Select } from './Select';
+export { default as Slider } from './Slider';
+export { default as Snippet } from './Snippet';
+export { default as Spacer } from './Spacer';
+export { default as Spinner } from './Spinner';
+export { default as Table } from './Table';
+export { default as Tabs } from './Tabs';
+export { default as Tag } from './Tag';
+export { default as Text } from './Text';
+export { default as Textarea } from './Textarea';
+export { default as Themes } from './Themes';
+export { default as Toggle } from './Toggle';
+export { default as Tooltip } from './Tooltip';
 export { default as useAllThemes } from './use-all-themes';
 export { default as useToasts } from './use-toasts';
 export { default as useBodyScroll } from './use-body-scroll';
@@ -61,10 +61,10 @@ export { default as useModal } from './use-modal';
 export { default as useTabs } from './use-tabs';
 export { default as useClickAway } from './use-click-away';
 export { default as useCurrentState } from './use-current-state';
-export { default as CssBaseline } from './css-baseline';
+export { default as CssBaseline } from './CssBaseline';
 export { default as useTheme } from './use-theme';
 export { default as useClasses } from './use-classes';
 export { default as useScale } from './use-scale';
 export { withScale, ScalePropKeys, ScaleContext } from './use-scale';
 export { useRect } from './utils/layouts';
-export { default as Highlight } from './shared/highlight';
+export { default as Highlight } from './Shared/highlight';

package/esm/use-all-themes/all-themes-context.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { BolioUIThemes } from "../Themes/Presets";
+export declare type AllThemesConfig = {
+    themes: Array<BolioUIThemes>;
+};
+export declare const AllThemesContext: React.Context<AllThemesConfig>;
+export declare const useAllThemes: () => AllThemesConfig;

package/esm/use-all-themes/all-themes-context.js

@@ -1,5 +1,5 @@
 import React from 'react';
-import Themes from '../themes/themes';
+import Themes from '../Themes/Themes';
 var defaultAllThemesConfig = {
   themes: Themes.getPresets()
 };

package/esm/use-all-themes/index.d.ts

@@ -0,0 +1,3 @@
+import { useAllThemes } from "./all-themes-context";
+export type { AllThemesConfig } from "./all-themes-context";
+export default useAllThemes;

package/esm/use-body-scroll/index.d.ts

@@ -0,0 +1,3 @@
+import useBodyScroll from "./use-body-scroll";
+export type { BodyScrollOptions } from "./use-body-scroll";
+export default useBodyScroll;

package/esm/use-body-scroll/use-body-scroll.d.ts

@@ -0,0 +1,11 @@
+import { Dispatch, RefObject, SetStateAction } from 'react';
+export declare type ElementStackItem = {
+    overflow: string;
+    paddingRight: string;
+};
+export declare type BodyScrollOptions = {
+    scrollLayer?: boolean;
+    delayReset?: number;
+};
+declare function useBodyScroll(elementRef?: RefObject<HTMLElement> | null, options?: BodyScrollOptions): [boolean, Dispatch<SetStateAction<boolean>>];
+export default useBodyScroll;

package/esm/use-classes/index.d.ts

@@ -0,0 +1,2 @@
+import { default as useClasses } from "./use-classes";
+export default useClasses;

package/esm/use-classes/use-classes.d.ts

@@ -0,0 +1,4 @@
+export declare type classNamesObject = Record<string, boolean | string | number | null | undefined>;
+export declare type className = string | classNamesObject | null | undefined | boolean | number;
+declare const useClasses: (...classNames: Array<className>) => string;
+export default useClasses;

package/esm/use-click-away/index.d.ts

@@ -0,0 +1,2 @@
+import useClickAway from "./use-click-away";
+export default useClickAway;

package/esm/use-click-away/use-click-away.d.ts

@@ -0,0 +1,4 @@
+import { MutableRefObject } from 'react';
+export declare type ClickAwayGetContainer = () => HTMLElement | null;
+declare const useClickAway: (ref: MutableRefObject<HTMLElement | null>, handler: (event: Event) => void) => void;
+export default useClickAway;

package/esm/use-clipboard/index.d.ts

@@ -0,0 +1,3 @@
+import useClipboard from "./use-clipboard";
+export type { UseClipboardOptions, UseClipboardResult } from "./use-clipboard";
+export default useClipboard;

package/esm/use-clipboard/use-clipboard.d.ts

@@ -0,0 +1,8 @@
+export declare type UseClipboardOptions = {
+    onError: () => unknown;
+};
+export declare type UseClipboardResult = {
+    copy: (text: string) => void;
+};
+declare const useClipboard: (options?: UseClipboardOptions) => UseClipboardResult;
+export default useClipboard;

package/esm/use-current-state/index.d.ts

@@ -0,0 +1,2 @@
+import useCurrentState from "./use-current-state";
+export default useCurrentState;

package/esm/use-current-state/use-current-state.d.ts

@@ -0,0 +1,8 @@
+import { Dispatch, MutableRefObject, SetStateAction } from 'react';
+export declare type CurrentStateType<S> = [
+    S,
+    Dispatch<SetStateAction<S>>,
+    MutableRefObject<S>
+];
+declare const useCurrentState: <S>(initialState: S | (() => S)) => CurrentStateType<S>;
+export default useCurrentState;

package/esm/use-input/index.d.ts

@@ -0,0 +1,3 @@
+import useInput from "./use-input";
+export type { BindingsChangeTarget } from "./use-input";
+export default useInput;

package/esm/use-input/use-input.d.ts

@@ -0,0 +1,13 @@
+import React, { Dispatch, MutableRefObject, SetStateAction } from 'react';
+export declare type BindingsChangeTarget = React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement> | string;
+declare const useInput: (initialValue: string) => {
+    state: string;
+    setState: Dispatch<SetStateAction<string>>;
+    currentRef: MutableRefObject<string>;
+    reset: () => void;
+    bindings: {
+        value: string;
+        onChange: (event: BindingsChangeTarget) => void;
+    };
+};
+export default useInput;

package/esm/use-keyboard/codes.d.ts

@@ -0,0 +1,92 @@
+/**
+ * KeyBinding Codes
+ * The content of this file is based on the design of the open source project "microsoft/vscode",
+ *   Copyright (c) Microsoft Corporation. All rights reserved.
+ *
+ * We inherit the KeyMod values from "microsoft/vscode",
+ * but use the Browser's KeyboardEvent event implementation, and all values are used only as identification.
+ */
+export declare enum KeyCode {
+    Unknown = 0,
+    Backspace = 8,
+    Tab = 9,
+    Enter = 13,
+    Shift = 16,
+    Ctrl = 17,
+    Alt = 18,
+    PauseBreak = 19,
+    CapsLock = 20,
+    Escape = 27,
+    Space = 32,
+    PageUp = 33,
+    PageDown = 34,
+    End = 35,
+    Home = 36,
+    LeftArrow = 37,
+    UpArrow = 38,
+    RightArrow = 39,
+    DownArrow = 40,
+    Insert = 45,
+    Delete = 46,
+    KEY_0 = 48,
+    KEY_1 = 49,
+    KEY_2 = 50,
+    KEY_3 = 51,
+    KEY_4 = 52,
+    KEY_5 = 53,
+    KEY_6 = 54,
+    KEY_7 = 55,
+    KEY_8 = 56,
+    KEY_9 = 57,
+    KEY_A = 65,
+    KEY_B = 66,
+    KEY_C = 67,
+    KEY_D = 68,
+    KEY_E = 69,
+    KEY_F = 70,
+    KEY_G = 71,
+    KEY_H = 72,
+    KEY_I = 73,
+    KEY_J = 74,
+    KEY_K = 75,
+    KEY_L = 76,
+    KEY_M = 77,
+    KEY_N = 78,
+    KEY_O = 79,
+    KEY_P = 80,
+    KEY_Q = 81,
+    KEY_R = 82,
+    KEY_S = 83,
+    KEY_T = 84,
+    KEY_U = 85,
+    KEY_V = 86,
+    KEY_W = 87,
+    KEY_X = 88,
+    KEY_Y = 89,
+    KEY_Z = 90,
+    Meta = 91,
+    F1 = 112,
+    F2 = 113,
+    F3 = 114,
+    F4 = 115,
+    F5 = 116,
+    F6 = 117,
+    F7 = 118,
+    F8 = 119,
+    F9 = 120,
+    F10 = 121,
+    F11 = 122,
+    F12 = 123,
+    NumLock = 144,
+    ScrollLock = 145,
+    Equal = 187,
+    Minus = 189,
+    Backquote = 192,
+    Backslash = 220
+}
+export declare enum KeyMod {
+    CtrlCmd = 2048,
+    Shift = 1024,
+    Alt = 512,
+    WinCtrl = 256
+}

package/esm/use-keyboard/helper.d.ts

@@ -0,0 +1,3 @@
+import { KeyMod } from "./codes";
+export declare const getCtrlKeysByPlatform: () => Record<string, 'metaKey' | 'ctrlKey'>;
+export declare const getActiveModMap: (bindings: number[]) => Record<keyof typeof KeyMod, boolean>;

package/esm/use-keyboard/index.d.ts

@@ -0,0 +1,5 @@
+import useKeyboard from "./use-keyboard";
+import { KeyMod, KeyCode } from "./codes";
+export { KeyMod, KeyCode };
+export type { UseKeyboardHandler, KeyboardOptions, KeyboardResult, UseKeyboard } from "./use-keyboard";
+export default useKeyboard;