@tatuarvela/wisp - npm Package Compare versions

Comparing version 4.2.2 to 4.3.0

dist/index.d.ts

@@ -12,3 +12,3 @@ import * as styled_components from 'styled-components';
 
-declare const ControlsProperties: readonly ["AddressBarElement", "AddressBarInput", "AddressBarInputContainer", "AddressBarIcon", "AddressBarLabel", "AlertButtonElement", "AlertContent", "AlertText", "ButtonElement", "ButtonWrapper", "CheckboxElement", "CheckboxLabel", "CheckboxWrapper", "ComboBoxButton", "ComboBoxControl", "ComboBoxInput", "ComboBoxLabel", "ComboBoxOption", "ComboBoxOptions", "ComboBoxWrapper", "ControlWrapper", "Divider", "FieldsetElement", "FieldsetLegend", "Label", "ListBoxButton", "ListBoxControl", "ListBoxValue", "ListBoxLabel", "ListBoxOption", "ListBoxOptions", "ListBoxWrapper", "MenuBarElement", "MenuBarThrobberIconElement", "MenuBarThrobberContainer", "ProgressBarElement", "ProgressBarFill", "ScrollableContentView", "ScrollableContentWrapper", "ScrollbarHorizontalWrapper", "ScrollbarHorizontalTrack", "ScrollbarHorizontalThumb", "ScrollLeftButton", "ScrollRightButton", "ScrollbarVerticalWrapper", "ScrollbarVerticalTrack", "ScrollbarVerticalThumb", "ScrollDownButton", "ScrollUpButton", "StatusBarSectionElement", "ResizeHandle", "StatusBarElement", "TextareaWrapper", "TextareaLabel", "TextareaElement", "TextInputElement", "TextInputLabel", "TextInputWrapper", "TimeInputWrapper", "TimeInputLabel", "TimeInputControl", "TimeInputField", "TimeInputValue", "TimeInputSeparator", "TimeInputButtons", "TimeInputIncreaseButton", "TimeInputDecreaseButton", "ToolbarElement", "ToolbarButtonElement", "ToolbarButtonWrapper", "ToolbarButtonLabel", "ToolbarButtonIconElement", "Well", "WindowContent"];
+declare const ControlsProperties: readonly ["AddressBarElement", "AddressBarInput", "AddressBarInputContainer", "AddressBarIcon", "AddressBarLabel", "ButtonElement", "ButtonWrapper", "CheckboxElement", "CheckboxLabel", "CheckboxWrapper", "ComboBoxButton", "ComboBoxControl", "ComboBoxInput", "ComboBoxLabel", "ComboBoxOption", "ComboBoxOptions", "ComboBoxWrapper", "ControlWrapper", "Divider", "FieldsetElement", "FieldsetLegend", "Label", "ListBoxButton", "ListBoxControl", "ListBoxValue", "ListBoxLabel", "ListBoxOption", "ListBoxOptions", "ListBoxWrapper", "MenuBarElement", "MenuBarThrobberIconElement", "MenuBarThrobberContainer", "MessageBoxButtonElement", "MessageBoxContent", "MessageBoxText", "ProgressBarElement", "ProgressBarFill", "ScrollableContentView", "ScrollableContentWrapper", "ScrollbarHorizontalWrapper", "ScrollbarHorizontalTrack", "ScrollbarHorizontalThumb", "ScrollLeftButton", "ScrollRightButton", "ScrollbarVerticalWrapper", "ScrollbarVerticalTrack", "ScrollbarVerticalThumb", "ScrollDownButton", "ScrollUpButton", "StatusBarSectionElement", "ResizeHandle", "StatusBarElement", "TextInputElement", "TextInputLabel", "TextInputWrapper", "TextareaWrapper", "TextareaLabel", "TextareaElement", "TimeInputWrapper", "TimeInputLabel", "TimeInputControl", "TimeInputField", "TimeInputValue", "TimeInputSeparator", "TimeInputButtons", "TimeInputIncreaseButton", "TimeInputDecreaseButton", "ToolbarButtonElement", "ToolbarButtonWrapper", "ToolbarButtonLabel", "ToolbarButtonIconElement", "ToolbarElement", "Well", "WindowContent"];
 declare const ElementsProperties: readonly ["Desktop", "TaskbarButtonElement", "TaskbarButtonTitle", "TaskbarButtonIconElement", "TaskbarElement", "VersionInfoElement"];
@@ -43,5 +43,8 @@ declare const WindowProperties: readonly ["NResize", "NEResize", "EResize", "SEResize", "SResize", "SWResize", "WResize", "NWResize", "TitleBarElement", "TitleBarTitleContainer", "TitleBarTitle", "TitleBarIcon", "TitleBarButtonsElement", "WindowButton", "MinimizeButton", "MaximizeButton", "UnmaximizeButton", "CloseButton", "WindowElementContent", "WindowElement"];
     activeWindowId: string | null;
+    config: WispConfig;
     windows: Map<string, WindowType>;
     windowOrder: string[];
-    viewportWindowMargins: ViewportWindowMargins;
+    viewportHeight: number | null;
+    viewportWidth: number | null;
+    viewportMargins: ViewportMargins;
 }
@@ -58,6 +61,3 @@ interface ActivateWindowAction {
     type: 'CREATE_WINDOW';
-    payload: {
-        config: WispConfig;
-        props: InitialWindow;
-    };
+    payload: InitialWindow;
 }
@@ -70,13 +70,10 @@ interface DeactivateWindowAction {
     type: 'UPDATE_WINDOW';
-    payload: {
-        id: string;
-        props: Partial<WindowType>;
-    };
+    payload: Pick<WindowType, 'id'> & Partial<WindowType>;
 }
-interface SetViewportWindowMarginsAction {
-    type: 'SET_WINDOW_MARGINS';
-    payload: Partial<ViewportWindowMargins>;
+interface UpdateViewportMarginsAction {
+    type: 'UPDATE_VIEWPORT_MARGINS';
+    payload: ViewportMargins;
 }
-interface RefitWindowsAction {
-    type: 'REFIT_WINDOWS';
+interface UpdateViewportSizeAction {
+    type: 'UPDATE_VIEWPORT_SIZE';
     payload: {
@@ -87,24 +84,40 @@ height: number;
 }
-type WindowManagerAction = ActivateWindowAction | CloseWindowAction | CreateWindowAction | DeactivateWindowAction | UpdateWindowAction | SetViewportWindowMarginsAction | RefitWindowsAction;
-type BaseMethods = {
-    activateWindow(id: string): void;
-    closeWindow(id: string): void;
-    createWindow(initial: InitialWindow): WindowType;
-    deactivateWindow(id: string): void;
-    getViewportHeight(): number;
-    getViewportWidth(): number;
-    setViewportWindowMargins(viewportWindowMargins: Partial<ViewportWindowMargins>): void;
-    updateWindow(id: string, props: Partial<WindowType>): void;
+interface MaximizeWindowAction {
+    type: 'MAXIMIZE_WINDOW';
+    payload: string;
+}
+interface MinimizeWindowAction {
+    type: 'MINIMIZE_WINDOW';
+    payload: string;
+}
+interface RestoreWindowAction {
+    type: 'RESTORE_WINDOW';
+    payload: string;
+}
+interface UnmaximizeWindowAction {
+    type: 'UNMAXIMIZE_WINDOW';
+    payload: string;
+}
+interface SetConfigAction {
+    type: 'SET_CONFIG';
+    payload: WispConfig;
+}
+type WindowManagerAction = ActivateWindowAction | CloseWindowAction | CreateWindowAction | DeactivateWindowAction | MaximizeWindowAction | MinimizeWindowAction | RestoreWindowAction | UpdateViewportMarginsAction | UnmaximizeWindowAction | UpdateViewportSizeAction | UpdateWindowAction | SetConfigAction;
+type ActionPayload = {
+    [K in WindowManagerAction as K['type']]: K['payload'];
 };
-type WindowStateMethods = {
-    maximizeWindow(id: string): void;
-    minimizeWindow(id: string): void;
-    restoreWindow(id: string): void;
-    unmaximizeWindow(id: string): void;
+
+type WindowManagerActions = {
+    activateWindow(payload: ActionPayload['ACTIVATE_WINDOW']): void;
+    closeWindow(payload: ActionPayload['CLOSE_WINDOW']): void;
+    createWindow(payload: ActionPayload['CREATE_WINDOW']): void;
+    deactivateWindow(payload: ActionPayload['DEACTIVATE_WINDOW']): void;
+    maximizeWindow(payload: ActionPayload['MAXIMIZE_WINDOW']): void;
+    minimizeWindow(payload: ActionPayload['MINIMIZE_WINDOW']): void;
+    restoreWindow(payload: ActionPayload['RESTORE_WINDOW']): void;
+    setViewportWindowMargins(payload: ActionPayload['UPDATE_VIEWPORT_MARGINS']): void;
+    unmaximizeWindow(payload: ActionPayload['UNMAXIMIZE_WINDOW']): void;
+    updateWindow(payload: ActionPayload['UPDATE_WINDOW']): void;
 };
-interface WindowManagerBase extends WindowManagerState, BaseMethods {
-    viewportRef: React.Ref<HTMLDivElement>;
-}
-interface WindowManager extends WindowManagerBase, WindowStateMethods {
-}
+type WindowManager = WindowManagerState & WindowManagerActions;
 interface WindowType {
@@ -123,2 +136,3 @@ alwaysShowCloseButton?: boolean;
     isMinimized: boolean;
+    isModal: boolean;
     isResizable: boolean;
@@ -129,2 +143,3 @@ maxHeight?: number;
     minWidth?: number;
+    parentId: string | null;
     positionX: number;
@@ -140,7 +155,7 @@ positionY: number;
 } & Partial<Omit<WindowType, 'height' | 'width'>>;
-interface ViewportWindowMargins {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
+interface ViewportMargins {
+    top?: number;
+    right?: number;
+    bottom?: number;
+    left?: number;
 }
@@ -177,3 +192,3 @@ interface Boundaries {
     themes: Theme[];
-    viewportWindowMargins: ViewportWindowMargins;
+    viewportMargins: ViewportMargins;
 }
@@ -222,12 +237,2 @@ declare const defaultConfig: WispConfig;
 
-declare const AlertButtonThemeProperties: readonly ["AlertButtonElement"];
-
-declare const AlertContentThemeProperties: readonly ["AlertContent"];
-
-declare const AlertIconThemeProperties: readonly ["AlertIcon"];
-declare const AlertIcon: styled_components.StyledComponent<"img", any, {}, never>;
-
-declare const AlertTextThemeProperties: readonly ["AlertText"];
-declare const AlertText: styled_components.StyledComponent<"div", any, {}, never>;
-
 declare const ControlWrapperThemeProperties: readonly ["ControlWrapper"];
@@ -342,2 +347,11 @@ interface ControlWrapperProps {
 
+declare const MessageBoxButtonThemeProperties: readonly ["MessageBoxButtonElement"];
+
+declare const MessageBoxContentThemeProperties: readonly ["MessageBoxContent"];
+
+declare const MessageBoxIconThemeProperties: readonly ["MessageBoxIconElement"];
+
+declare const MessageBoxTextThemeProperties: readonly ["MessageBoxText"];
+declare const MessageBoxText: styled_components.StyledComponent<"div", any, {}, never>;
+
 declare const ProgressBarThemeProperties: readonly ["ProgressBarElement", "ProgressBarFill"];
@@ -616,3 +630,3 @@ interface ProgressBarFillProps {
     orderNumber: number;
-    viewportWindowMargins: ViewportWindowMargins;
+    viewportMargins: ViewportMargins;
 }
@@ -623,7 +637,7 @@
 type MessageBoxProps = WindowProps & {
-    alertIcon?: string | Icon;
+    messageBoxIcon?: string | Icon;
     buttonText?: string;
     onButtonClick?(): void;
 };
-declare const MessageBox: ({ alertIcon, buttonText, onButtonClick, height, width, ...windowProps }: MessageBoxProps) => React.JSX.Element;
+declare const MessageBox: ({ alwaysShowCloseButton, buttonText, height, isClosable, isMaximizable, isMinimizable, isModal, isResizable, messageBoxIcon, onButtonClick, showAsTask, width, ...windowProps }: MessageBoxProps) => React.JSX.Element;
 
@@ -643,2 +657,2 @@ declare const WindowContext: React.Context<WindowType>;
 
-export { AddressBar, type AddressBarElementProps, type AddressBarIconProps, type AddressBarInputContainerProps, type AddressBarInputProps, type AddressBarLabelProps, type AddressBarProps, AddressBarThemeProperties, AlertButtonThemeProperties, AlertContentThemeProperties, AlertIcon, AlertIconThemeProperties, AlertText, AlertTextThemeProperties, type BaseMethods, type Boundaries, Button, type ButtonElementProps, type ButtonProps, ButtonThemeProperties, type ButtonWrapperProps, Checkbox, type CheckboxElementProps, type CheckboxLabelProps, type CheckboxProps, CheckboxThemeProperties, ComboBox, type ComboBoxButtonProps, type ComboBoxInputProps, type ComboBoxLabelProps, type ComboBoxOptionsProps, type ComboBoxProps, ComboBoxThemeProperties, ControlStoryDecorator, type ControlWrapperProps, ControlWrapperThemeProperties, type ControlsThemeSection, Desktop, DesktopThemeProperties, Direction, Divider, type DividerProps, DividerThemeProperties, type ElementsThemeSection, Fieldset, type FieldsetProps, FieldsetThemeProperties, type FullTheme, type Icon, type IconKey, type IconsThemeSection, type InitialWindow, Label, type LabelProps, LabelThemeProperties, ListBox, type ListBoxButtonProps, type ListBoxLabelProps, type ListBoxOptionsProps, type ListBoxProps, ListBoxThemeProperties, type ListBoxValueProps, MenuBar, type MenuBarProps, MenuBarThemeProperties, type MenuBarThrobberIconElementProps, type MenuBarThrobberIconProps, type MenuBarThrobberProps, MessageBox, type MessageBoxProps, ProgressBar, type ProgressBarElementProps, type ProgressBarFillProps, type ProgressBarProps, ProgressBarThemeProperties, ResizeBorderThemeProperties, ScrollableContent, type ScrollableContentProps, ScrollableContentThemeProperties, type ScrollableContentViewProps, type ScrollbarHorizontalProps, ScrollbarHorizontalThemeProperties, type ScrollbarVerticalProps, ScrollbarVerticalThemeProperties, StatusBar, type StatusBarProps, StatusBarSection, type StatusBarSectionElementProps, type StatusBarSectionProps, StatusBarSectionThemeProperties, StatusBarThemeProperties, TaskbarButton, type TaskbarButtonElementProps, type TaskbarButtonIconProps, type TaskbarButtonProps, TaskbarButtonThemeProperties, TaskbarThemeProperties, TextInput, type TextInputElementProps, type TextInputLabelProps, type TextInputProps, TextInputThemeProperties, Textarea, type TextareaElementProps, type TextareaLabelProps, type TextareaProps, TextareaThemeProperties, type Theme, ThemeSwitcher, type ThemeSwitcherProps, type Time, TimeInput, type TimeInputButtonProps, type TimeInputFieldProps, type TimeInputLabelProps, type TimeInputProps, TimeInputThemeProperties, type TimeInputValueProps, type TitleBarButtonsProps, TitleBarButtonsThemeProperties, type TitleBarElementProps, type TitleBarProps, TitleBarThemeProperties, Toolbar, ToolbarButton, type ToolbarButtonElementProps, type ToolbarButtonIconProps, type ToolbarButtonProps, ToolbarButtonThemeProperties, type ToolbarButtonWrapperProps, type ToolbarProps, ToolbarThemeProperties, VersionInfo, VersionInfoThemeProperties, type ViewportWindowMargins, Well, WellThemeProperties, Window, WindowContent, WindowContentThemeProperties, WindowContext, WindowElementContentThemeProperties, type WindowElementProps, WindowElementThemeProperties, type WindowManager, type WindowManagerAction, type WindowManagerBase, type WindowManagerState, type WindowProps, WindowProvider, type WindowStateMethods, WindowStoryDecorator, type WindowThemeSection, type WindowType, Wisp, type WispConfig, type WispProps, buildControlStoryDecorator, defaultConfig, defaultTheme, statefulProps, statefulPropsDecorator, storybookConfigContextDecorator, useThemeManager, useWindow, useWindowById, useWindowManager, useWindowOrderNumberById };
+export { AddressBar, type AddressBarElementProps, type AddressBarIconProps, type AddressBarInputContainerProps, type AddressBarInputProps, type AddressBarLabelProps, type AddressBarProps, AddressBarThemeProperties, type Boundaries, Button, type ButtonElementProps, type ButtonProps, ButtonThemeProperties, type ButtonWrapperProps, Checkbox, type CheckboxElementProps, type CheckboxLabelProps, type CheckboxProps, CheckboxThemeProperties, ComboBox, type ComboBoxButtonProps, type ComboBoxInputProps, type ComboBoxLabelProps, type ComboBoxOptionsProps, type ComboBoxProps, ComboBoxThemeProperties, ControlStoryDecorator, type ControlWrapperProps, ControlWrapperThemeProperties, type ControlsThemeSection, Desktop, DesktopThemeProperties, Direction, Divider, type DividerProps, DividerThemeProperties, type ElementsThemeSection, Fieldset, type FieldsetProps, FieldsetThemeProperties, type FullTheme, type Icon, type IconKey, type IconsThemeSection, type InitialWindow, Label, type LabelProps, LabelThemeProperties, ListBox, type ListBoxButtonProps, type ListBoxLabelProps, type ListBoxOptionsProps, type ListBoxProps, ListBoxThemeProperties, type ListBoxValueProps, MenuBar, type MenuBarProps, MenuBarThemeProperties, type MenuBarThrobberIconElementProps, type MenuBarThrobberIconProps, type MenuBarThrobberProps, MessageBox, MessageBoxButtonThemeProperties, MessageBoxContentThemeProperties, MessageBoxIconThemeProperties, type MessageBoxProps, MessageBoxText, MessageBoxTextThemeProperties, ProgressBar, type ProgressBarElementProps, type ProgressBarFillProps, type ProgressBarProps, ProgressBarThemeProperties, ResizeBorderThemeProperties, ScrollableContent, type ScrollableContentProps, ScrollableContentThemeProperties, type ScrollableContentViewProps, type ScrollbarHorizontalProps, ScrollbarHorizontalThemeProperties, type ScrollbarVerticalProps, ScrollbarVerticalThemeProperties, StatusBar, type StatusBarProps, StatusBarSection, type StatusBarSectionElementProps, type StatusBarSectionProps, StatusBarSectionThemeProperties, StatusBarThemeProperties, TaskbarButton, type TaskbarButtonElementProps, type TaskbarButtonIconProps, type TaskbarButtonProps, TaskbarButtonThemeProperties, TaskbarThemeProperties, TextInput, type TextInputElementProps, type TextInputLabelProps, type TextInputProps, TextInputThemeProperties, Textarea, type TextareaElementProps, type TextareaLabelProps, type TextareaProps, TextareaThemeProperties, type Theme, ThemeSwitcher, type ThemeSwitcherProps, type Time, TimeInput, type TimeInputButtonProps, type TimeInputFieldProps, type TimeInputLabelProps, type TimeInputProps, TimeInputThemeProperties, type TimeInputValueProps, type TitleBarButtonsProps, TitleBarButtonsThemeProperties, type TitleBarElementProps, type TitleBarProps, TitleBarThemeProperties, Toolbar, ToolbarButton, type ToolbarButtonElementProps, type ToolbarButtonIconProps, type ToolbarButtonProps, ToolbarButtonThemeProperties, type ToolbarButtonWrapperProps, type ToolbarProps, ToolbarThemeProperties, VersionInfo, VersionInfoThemeProperties, type ViewportMargins, Well, WellThemeProperties, Window, WindowContent, WindowContentThemeProperties, WindowContext, WindowElementContentThemeProperties, type WindowElementProps, WindowElementThemeProperties, type WindowManager, type WindowManagerActions, type WindowProps, WindowProvider, WindowStoryDecorator, type WindowThemeSection, type WindowType, Wisp, type WispConfig, type WispProps, buildControlStoryDecorator, defaultConfig, defaultTheme, statefulProps, statefulPropsDecorator, storybookConfigContextDecorator, useThemeManager, useWindow, useWindowById, useWindowManager, useWindowOrderNumberById };

package.json

 {
   "name": "@tatuarvela/wisp",
-  "version": "4.2.2",
+  "version": "4.3.0",
   "description": "Window manager and widget toolkit",
@@ -5,0 +5,0 @@ "main": "dist/index.cjs.js",

No alert changes

Improved metrics

Total package byte prevSize

685612

increased by0.47%

Lines of code

5615

increased by0.29%

No dependency changes