@muraldevkit/ui-toolkit 1.27.1 → 1.29.0

package/dist/index.js.LICENSE.txt

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Lodash <https://lodash.com/>
+ * Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
+ * Released under MIT license <https://lodash.com/license>
+ * Based on Underscore.js 1.8.3 <http://underscorejs.org/LICENSE>
+ * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
+ */

package/dist/src/components/text/MrlText/MrlText.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+import { AttrsObject } from '../../../utils';
+import { TextSizes } from '../constants';
+interface MrlTextProps {
+    /** Applies additional HTML attributes to the text element */
+    attrs?: AttrsObject;
+    /** Children to be rendered within the text component */
+    children?: React.ReactNode | string;
+    /** Visual size of the text element */
+    size?: TextSizes;
+    /** Textual content when it's a static string; if you have nested elements, use children to provide content */
+    text?: string;
+}
+/**
+ * MrlText Component
+ *
+ * @param {MrlTextProps} props - MrlText component props
+ * @returns a paragraph element
+ */
+export declare function MrlText(props: MrlTextProps): JSX.Element;
+export {};

package/dist/{components → src/components}/text/MrlTextHeading/MrlTextHeading.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { AttrsObject } from '../../../utils';
-import { LevelType, HeadingSizes, TextSizes, TextHierarchies, HeadingKinds } from '../constants';
+import { LevelType, HeadingHierarchies, HeadingSizes, TextSizes, HeadingKinds } from '../constants';
 interface MrlTextHeadingProps {
     /** Applies additional HTML attributes to the text element */
     attrs?: AttrsObject;
@@ -16,9 +16,8 @@ interface MrlTextHeadingProps {
      */
     size?: HeadingSizes | TextSizes;
     /** Clear and concise description of the content that the heading describes */
+    hierarchy?: HeadingHierarchies;
     text?: string;
-    /** Hierarchy level within the use case and sizing scales */
-    hierarchy?: TextHierarchies;
 }
 /**
  * MuralTextHeading component

package/dist/{components → src/components}/text/constants.d.ts

@@ -1,16 +1,10 @@
 import { AttrsObject } from '../../utils';
 export type TextSizes = 'xxsmall' | 'xsmall' | 'small' | 'medium' | 'large';
-export type TextHierarchies = 'primary' | 'secondary';
-export type TextKinds = 'default' | 'body' | 'meta' | 'supporting';
 export interface TextDefaults {
     attrs: AttrsObject;
-    hierarchy: TextHierarchies;
     size: TextSizes;
-    kind: TextKinds;
 }
 export declare const textAllowedValues: {
-    hierarchy: string[];
-    kind: string[];
     sizes: string[];
 };
 /**
@@ -21,9 +15,10 @@ export declare const textDefaults: TextDefaults;
 export type LevelType = '1' | '2' | '3' | '4' | '5' | '6';
 export type HeadingKinds = 'poster' | 'display' | 'headline' | 'title';
 export type HeadingSizes = 'small' | 'medium' | 'large';
+export type HeadingHierarchies = 'primary' | 'secondary';
 export interface HeadingDefaults {
     attrs: AttrsObject;
-    hierarchy: TextHierarchies;
+    hierarchy: HeadingHierarchies;
     kind: HeadingKinds;
     level: LevelType;
     size: HeadingSizes | TextSizes;
@@ -33,6 +28,7 @@ export interface HeadingDefaults {
  * used for Storybook and testing
  */
 export declare const headingAllowedValues: {
+    hierarchy: string[];
     kinds: string[];
     level: string[];
     sizes: string[];

package/dist/src/hooks/index.d.ts

@@ -0,0 +1 @@
+export * from './useVirtualKeyboard';

package/dist/src/hooks/useVirtualKeyboard/index.d.ts

@@ -0,0 +1 @@
+export * from './useVirtualKeyboard';

package/dist/src/hooks/useVirtualKeyboard/useVirtualKeyboard.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Custom event name for the virtual keyboard.
+ */
+export declare const MRL_VIRTUAL_KEYBOARD_EVENT_NAME = "mrl-virtual-keyboard";
+/**
+ * Virtual keyboard event with the keyboard height information.
+ */
+export type MrlVirtualKeyboardEvent = CustomEvent<{
+    height: number;
+}>;
+/**
+ * Utility function to dispatch MrlKeyboardEvent from consumer
+ *
+ * @param height the height of the virtual keyboard, 0 if closed
+ */
+export declare function dispatchMrlKeyboardEvent(height: number): void;
+/**
+ * Hook to access the virtual keyboard height
+ *
+ * @param disabled If disabled will always return 0
+ * @param content If a content is passed, this hook will return the height of the overlap between content and keyboard
+ * @returns virtual keyboard height or 0 if there isn't any.
+ */
+export declare function useVirtualKeyboard(disabled: boolean, content?: HTMLElement | null): number;

package/dist/{index.d.ts → src/index.d.ts}

@@ -1,3 +1,4 @@
 export * from './components';
 export * from './utils';
 export * from './contexts';
+export * from './hooks';

package/dist/{utils → src/utils}/index.d.ts

@@ -4,3 +4,4 @@ export * from './isObject';
 export * from './setAttributes';
 export * from './noop';
 export * from './trapFocus';
+export * from './scrollToElementWithLabel';

package/dist/src/utils/scrollToElementWithLabel/index.d.ts

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

package/dist/src/utils/scrollToElementWithLabel/scrollToElementWithLabel.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Scroll element into view. If is an input or textarea, will scroll to it or the higher label associated to it.
+ *
+ * @param element to be scrolled into view
+ */
+export declare function scrollToElementWithLabel(element: Element): void;

package/dist/src/utils/setAttributes/setAttributes.test.d.ts

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

package/dist/styles/MrlModal/global.scss

@@ -16,11 +16,9 @@
 
 	.mrl-native-modal,
 	.mrl-display-modal {
-		max-height: calc(100vh - var(--mrl-spacing-09) - var(--mrl-spacing-08));
-		min-height: min(
-			var(--mrl-modal-max-height),
-			calc(100vh - var(--mrl-spacing-09) - var(--mrl-spacing-08))
-		);
+		height: min(var(--mrl-modal-max-height), 100vh - var(--mrl-spacing-09) - var(--mrl-spacing-08));
+		margin-bottom: initial;
+		max-height: initial;
 	}
 }
 

package/dist/styles/MrlText/variables.scss

@@ -20,20 +20,3 @@
 		}
 	}
 }
-
-.MrlText--secondary {
-	--mrl-text-weight: var(--mrl-type-weight-text-secondary);
-}
-
-.MrlText--body {
-	--mrl-text-height: var(--mrl-type-line-height-text);
-	--mrl-text-weight: var(--mrl-type-weight-text);
-	--mrl-text-size: var(--mrl-type-size-text-xsmall);
-}
-
-.MrlText--meta,
-.MrlText--supporting {
-	--mrl-text-height: var(--mrl-type-line-height-text);
-	--mrl-text-weight: var(--mrl-type-weight-title-secondary);
-	--mrl-text-size: var(--mrl-type-size-text-xxsmall);
-}

package/dist/tests/mocks/patchGetBoundingRect.d.ts

@@ -0,0 +1,7 @@
+/**
+ * getBoundingRect is not properly implemented in JSDom (it returns always 0). This function allows to set a hardcoded response for it.
+ *
+ * @param element the DOM to be patched
+ * @param patch a DOMReact to be returned by getBoundingReact
+ */
+export declare function patchGetBoundingRect(element: HTMLElement, patch: Partial<DOMRect>): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@muraldevkit/ui-toolkit",
-	"version": "1.27.1",
+	"version": "1.29.0",
 	"description": "Mural's UI Toolkit",
 	"main": "./dist/index.js",
 	"module": "./dist/index.js",

package/dist/components/text/MrlText/MrlText.d.ts

@@ -1,38 +0,0 @@
-import React from 'react';
-import { AttrsObject } from '../../../utils';
-import { TextHierarchies, TextKinds, TextSizes } from '../constants';
-interface CommonProps {
-    /** Applies additional HTML attributes to the text element */
-    attrs?: AttrsObject;
-    /** Children to be rendered within the text component */
-    children?: React.ReactNode | string;
-    /** Hierarchy level within the use case and sizing scales */
-    hierarchy?: TextHierarchies;
-    /** Textual content when it's a static string; if you have nested elements, use children to provide content */
-    text?: string;
-}
-interface DefaultKindWithSize extends CommonProps {
-    /**
-     * Visual kind of the text
-     * If the value is default it allows to change the "size" prop
-     */
-    kind: 'default';
-    /** Visual size of the text, only applies if kind="default" */
-    size: TextSizes;
-}
-interface KindWithoutSize extends CommonProps {
-    /**
-     * Visual kind of the text
-     * If the value is default it allows to change the "size" prop
-     */
-    kind: Exclude<TextKinds, 'default'>;
-}
-type MrlTextProps = DefaultKindWithSize | KindWithoutSize;
-/**
- * MrlText Component
- *
- * @param {MrlTextProps} props - MrlText component props
- * @returns a paragraph element
- */
-export declare function MrlText(props: MrlTextProps): JSX.Element;
-export {};