@lumx/react 3.21.2-alpha.3 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/_internal/{Cd8LPzmx.js → ClSM3-wl.js} +28 -74
- package/_internal/ClSM3-wl.js.map +1 -0
- package/index.d.ts +3 -0
- package/index.js +894 -1043
- package/index.js.map +1 -1
- package/package.json +3 -3
- package/utils/index.d.ts +1 -53
- package/utils/index.js +1 -1
- package/_internal/Cd8LPzmx.js.map +0 -1
|
@@ -1,8 +1,31 @@
|
|
|
1
|
-
import React__default, {
|
|
2
|
-
import isEmpty from 'lodash/isEmpty';
|
|
1
|
+
import React__default, { useContext, useEffect, createContext, useMemo, useRef } from 'react';
|
|
3
2
|
import { jsx, Fragment } from 'react/jsx-runtime';
|
|
3
|
+
import isEmpty from 'lodash/isEmpty';
|
|
4
4
|
import { createPortal } from 'react-dom';
|
|
5
|
-
|
|
5
|
+
|
|
6
|
+
const DisabledStateContext = /*#__PURE__*/React__default.createContext({
|
|
7
|
+
state: null
|
|
8
|
+
});
|
|
9
|
+
/**
|
|
10
|
+
* Disabled state provider.
|
|
11
|
+
* All nested LumX Design System components inherit this disabled state.
|
|
12
|
+
*/
|
|
13
|
+
function DisabledStateProvider({
|
|
14
|
+
children,
|
|
15
|
+
...value
|
|
16
|
+
}) {
|
|
17
|
+
return /*#__PURE__*/jsx(DisabledStateContext.Provider, {
|
|
18
|
+
value: value,
|
|
19
|
+
children: children
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Get DisabledState context value
|
|
25
|
+
*/
|
|
26
|
+
function useDisabledStateContext() {
|
|
27
|
+
return useContext(DisabledStateContext);
|
|
28
|
+
}
|
|
6
29
|
|
|
7
30
|
const EVENT_TYPES = ['mousedown', 'touchstart'];
|
|
8
31
|
function isClickAway(targets, refs) {
|
|
@@ -132,74 +155,5 @@ const Portal = ({
|
|
|
132
155
|
return /*#__PURE__*/createPortal(children, context.container);
|
|
133
156
|
};
|
|
134
157
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
});
|
|
138
|
-
/**
|
|
139
|
-
* Disabled state provider.
|
|
140
|
-
* All nested LumX Design System components inherit this disabled state.
|
|
141
|
-
*/
|
|
142
|
-
function DisabledStateProvider({
|
|
143
|
-
children,
|
|
144
|
-
...value
|
|
145
|
-
}) {
|
|
146
|
-
return /*#__PURE__*/jsx(DisabledStateContext.Provider, {
|
|
147
|
-
value: value,
|
|
148
|
-
children: children
|
|
149
|
-
});
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
/**
|
|
153
|
-
* Get DisabledState context value
|
|
154
|
-
*/
|
|
155
|
-
function useDisabledStateContext() {
|
|
156
|
-
return useContext(DisabledStateContext);
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
/**
|
|
160
|
-
* Hook that provides BEM class name utilities for a component.
|
|
161
|
-
*
|
|
162
|
-
* @param className - Base component class name (kebab-case)
|
|
163
|
-
* @returns Object with `block` and `element` utility functions
|
|
164
|
-
*
|
|
165
|
-
* @example
|
|
166
|
-
* const { block, element } = useClassnames('my-component');
|
|
167
|
-
*/
|
|
168
|
-
function useClassnames(className) {
|
|
169
|
-
return useMemo(() => {
|
|
170
|
-
return {
|
|
171
|
-
/**
|
|
172
|
-
* Generates BEM block class names with optional modifiers.
|
|
173
|
-
*
|
|
174
|
-
* @param modifier - Modifier string, object, or additional class names
|
|
175
|
-
* @param additionalClasses - Additional CSS classes to append
|
|
176
|
-
* @returns Generated class name string
|
|
177
|
-
*
|
|
178
|
-
* @example
|
|
179
|
-
* block() // 'my-component'
|
|
180
|
-
* block('active') // 'my-component my-component--active'
|
|
181
|
-
* block({ active: true, disabled: false }) // 'my-component my-component--active'
|
|
182
|
-
* block(['custom-class']) // 'my-component custom-class'
|
|
183
|
-
*/
|
|
184
|
-
block: classNames.bem.block(className),
|
|
185
|
-
/**
|
|
186
|
-
* Generates BEM element class names with optional modifiers.
|
|
187
|
-
*
|
|
188
|
-
* @param elementName - Element name
|
|
189
|
-
* @param modifier - Modifier string, object, or additional class names
|
|
190
|
-
* @param additionalClasses - Additional CSS classes to append
|
|
191
|
-
* @returns Generated class name string
|
|
192
|
-
*
|
|
193
|
-
* @example
|
|
194
|
-
* element('header') // 'my-component__header'
|
|
195
|
-
* element('header', 'large') // 'my-component__header my-component__header--large'
|
|
196
|
-
* element('header', { large: true, small: false }) // 'my-component__header my-component__header--large'
|
|
197
|
-
* element('header', ['custom-class']) // 'my-component__header custom-class'
|
|
198
|
-
*/
|
|
199
|
-
element: classNames.bem.element(className)
|
|
200
|
-
};
|
|
201
|
-
}, [className]);
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
export { ClickAwayProvider as C, DisabledStateProvider as D, Portal as P, PortalProvider as a, useClassnames as b, useDisabledStateContext as u };
|
|
205
|
-
//# sourceMappingURL=Cd8LPzmx.js.map
|
|
158
|
+
export { ClickAwayProvider as C, DisabledStateProvider as D, Portal as P, PortalProvider as a, useDisabledStateContext as u };
|
|
159
|
+
//# sourceMappingURL=ClSM3-wl.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ClSM3-wl.js","sources":["../../src/utils/disabled/DisabledStateContext.tsx","../../src/hooks/useClickAway.tsx","../../src/utils/ClickAwayProvider/ClickAwayProvider.tsx","../../src/utils/Portal/PortalProvider.tsx","../../src/utils/Portal/Portal.tsx"],"sourcesContent":["import React, { useContext } from 'react';\n\n/** Disable state */\ntype DisabledStateContextValue =\n | {\n state: 'disabled';\n }\n | { state: undefined | null };\n\nexport const DisabledStateContext = React.createContext<DisabledStateContextValue>({ state: null });\n\nexport type DisabledStateProviderProps = DisabledStateContextValue & {\n children: React.ReactNode;\n};\n\n/**\n * Disabled state provider.\n * All nested LumX Design System components inherit this disabled state.\n */\nexport function DisabledStateProvider({ children, ...value }: DisabledStateProviderProps) {\n return <DisabledStateContext.Provider value={value}>{children}</DisabledStateContext.Provider>;\n}\n\n/**\n * Get DisabledState context value\n */\nexport function useDisabledStateContext(): DisabledStateContextValue {\n return useContext(DisabledStateContext);\n}\n","import { RefObject, useEffect } from 'react';\n\nimport { Falsy } from '@lumx/react/utils/type';\n\nimport isEmpty from 'lodash/isEmpty';\n\nconst EVENT_TYPES = ['mousedown', 'touchstart'];\n\nfunction isClickAway(targets: HTMLElement[], refs: Array<RefObject<HTMLElement>>): boolean {\n // The targets elements are not contained in any of the listed element references.\n return !refs.some((ref) => targets.some((target) => ref?.current?.contains(target)));\n}\n\nexport interface ClickAwayParameters {\n /**\n * A callback function to call when the user clicks away from the elements.\n */\n callback: EventListener | Falsy;\n /**\n * Elements considered within the click away context (clicking outside them will trigger the click away callback).\n */\n childrenRefs: RefObject<Array<RefObject<HTMLElement>>>;\n}\n\n/**\n * Listen to clicks away from the given elements and callback the passed in function.\n *\n * Warning: If you need to detect click away on nested React portals, please use the `ClickAwayProvider` component.\n */\nexport function useClickAway({ callback, childrenRefs }: ClickAwayParameters): void {\n useEffect(() => {\n const { current: currentRefs } = childrenRefs;\n if (!callback || !currentRefs || isEmpty(currentRefs)) {\n return undefined;\n }\n const listener: EventListener = (evt) => {\n const targets = [evt.composedPath?.()[0], evt.target] as HTMLElement[];\n if (isClickAway(targets, currentRefs)) {\n callback(evt);\n }\n };\n\n EVENT_TYPES.forEach((evtType) => document.addEventListener(evtType, listener));\n return () => {\n EVENT_TYPES.forEach((evtType) => document.removeEventListener(evtType, listener));\n };\n }, [callback, childrenRefs]);\n}\n","import { createContext, RefObject, useContext, useEffect, useMemo, useRef } from 'react';\nimport { ClickAwayParameters, useClickAway } from '@lumx/react/hooks/useClickAway';\n\ninterface ContextValue {\n childrenRefs: Array<RefObject<HTMLElement>>;\n addRefs(...newChildrenRefs: Array<RefObject<HTMLElement>>): void;\n}\n\nconst ClickAwayAncestorContext = createContext<ContextValue | null>(null);\n\ninterface ClickAwayProviderProps extends ClickAwayParameters {\n /**\n * (Optional) Element that should be considered as part of the parent\n */\n parentRef?: RefObject<HTMLElement>;\n /**\n * Children\n */\n children?: React.ReactNode;\n}\n\n/**\n * Component combining the `useClickAway` hook with a React context to hook into the React component tree and make sure\n * we take into account both the DOM tree and the React tree to detect click away.\n *\n * @return the react component.\n */\nexport const ClickAwayProvider: React.FC<ClickAwayProviderProps> = ({\n children,\n callback,\n childrenRefs,\n parentRef,\n}) => {\n const parentContext = useContext(ClickAwayAncestorContext);\n const currentContext = useMemo(() => {\n const context: ContextValue = {\n childrenRefs: [],\n /**\n * Add element refs to the current context and propagate to the parent context.\n */\n addRefs(...newChildrenRefs) {\n // Add element refs that should be considered as inside the click away context.\n context.childrenRefs.push(...newChildrenRefs);\n\n if (parentContext) {\n // Also add then to the parent context\n parentContext.addRefs(...newChildrenRefs);\n if (parentRef) {\n // The parent element is also considered as inside the parent click away context but not inside the current context\n parentContext.addRefs(parentRef);\n }\n }\n },\n };\n return context;\n }, [parentContext, parentRef]);\n\n useEffect(() => {\n const { current: currentRefs } = childrenRefs;\n if (!currentRefs) {\n return;\n }\n currentContext.addRefs(...currentRefs);\n }, [currentContext, childrenRefs]);\n\n useClickAway({ callback, childrenRefs: useRef(currentContext.childrenRefs) });\n return <ClickAwayAncestorContext.Provider value={currentContext}>{children}</ClickAwayAncestorContext.Provider>;\n};\nClickAwayProvider.displayName = 'ClickAwayProvider';\n","import React from 'react';\n\ntype Container = DocumentFragment | Element;\n\n/**\n * Portal initializing function.\n * If it does not provide a container, the Portal children will render in classic React tree and not in a portal.\n */\nexport type PortalInit = () => {\n container?: Container;\n teardown?: () => void;\n};\n\nexport const PortalContext = React.createContext<PortalInit>(() => ({ container: document.body }));\n\nexport interface PortalProviderProps {\n children?: React.ReactNode;\n value: PortalInit;\n}\n\n/**\n * Customize where <Portal> wrapped elements render (tooltip, popover, dialog, etc.)\n */\nexport const PortalProvider: React.FC<PortalProviderProps> = PortalContext.Provider;\n","import React from 'react';\nimport { createPortal } from 'react-dom';\nimport { PortalContext } from './PortalProvider';\n\nexport interface PortalProps {\n enabled?: boolean;\n children: React.ReactNode;\n}\n\n/**\n * Render children in a portal outside the current DOM position\n * (defaults to `document.body` but can be customized with the PortalContextProvider)\n */\nexport const Portal: React.FC<PortalProps> = ({ children, enabled = true }) => {\n const init = React.useContext(PortalContext);\n const context = React.useMemo(\n () => {\n return enabled ? init() : null;\n },\n // Only update on 'enabled'\n // eslint-disable-next-line react-hooks/exhaustive-deps\n [enabled],\n );\n\n React.useLayoutEffect(() => {\n return context?.teardown;\n }, [context?.teardown, enabled]);\n\n if (!context?.container) {\n return <>{children}</>;\n }\n return createPortal(children, context.container);\n};\n"],"names":["DisabledStateContext","React","createContext","state","DisabledStateProvider","children","value","_jsx","Provider","useDisabledStateContext","useContext","EVENT_TYPES","isClickAway","targets","refs","some","ref","target","current","contains","useClickAway","callback","childrenRefs","useEffect","currentRefs","isEmpty","undefined","listener","evt","composedPath","forEach","evtType","document","addEventListener","removeEventListener","ClickAwayAncestorContext","ClickAwayProvider","parentRef","parentContext","currentContext","useMemo","context","addRefs","newChildrenRefs","push","useRef","displayName","PortalContext","container","body","PortalProvider","Portal","enabled","init","useLayoutEffect","teardown","_Fragment","createPortal"],"mappings":";;;;;AASO,MAAMA,oBAAoB,gBAAGC,cAAK,CAACC,aAAa,CAA4B;AAAEC,EAAAA,KAAK,EAAE;AAAK,CAAC,CAAC;AAMnG;AACA;AACA;AACA;AACO,SAASC,qBAAqBA,CAAC;EAAEC,QAAQ;EAAE,GAAGC;AAAkC,CAAC,EAAE;AACtF,EAAA,oBAAOC,GAAA,CAACP,oBAAoB,CAACQ,QAAQ,EAAA;AAACF,IAAAA,KAAK,EAAEA,KAAM;AAAAD,IAAAA,QAAA,EAAEA;AAAQ,GAAgC,CAAC;AAClG;;AAEA;AACA;AACA;AACO,SAASI,uBAAuBA,GAA8B;EACjE,OAAOC,UAAU,CAACV,oBAAoB,CAAC;AAC3C;;ACtBA,MAAMW,WAAW,GAAG,CAAC,WAAW,EAAE,YAAY,CAAC;AAE/C,SAASC,WAAWA,CAACC,OAAsB,EAAEC,IAAmC,EAAW;AACvF;EACA,OAAO,CAACA,IAAI,CAACC,IAAI,CAAEC,GAAG,IAAKH,OAAO,CAACE,IAAI,CAAEE,MAAM,IAAKD,GAAG,EAAEE,OAAO,EAAEC,QAAQ,CAACF,MAAM,CAAC,CAAC,CAAC;AACxF;AAaA;AACA;AACA;AACA;AACA;AACO,SAASG,YAAYA,CAAC;EAAEC,QAAQ;AAAEC,EAAAA;AAAkC,CAAC,EAAQ;AAChFC,EAAAA,SAAS,CAAC,MAAM;IACZ,MAAM;AAAEL,MAAAA,OAAO,EAAEM;AAAY,KAAC,GAAGF,YAAY;IAC7C,IAAI,CAACD,QAAQ,IAAI,CAACG,WAAW,IAAIC,OAAO,CAACD,WAAW,CAAC,EAAE;AACnD,MAAA,OAAOE,SAAS;AACpB,IAAA;IACA,MAAMC,QAAuB,GAAIC,GAAG,IAAK;AACrC,MAAA,MAAMf,OAAO,GAAG,CAACe,GAAG,CAACC,YAAY,IAAI,CAAC,CAAC,CAAC,EAAED,GAAG,CAACX,MAAM,CAAkB;AACtE,MAAA,IAAIL,WAAW,CAACC,OAAO,EAAEW,WAAW,CAAC,EAAE;QACnCH,QAAQ,CAACO,GAAG,CAAC;AACjB,MAAA;IACJ,CAAC;AAEDjB,IAAAA,WAAW,CAACmB,OAAO,CAAEC,OAAO,IAAKC,QAAQ,CAACC,gBAAgB,CAACF,OAAO,EAAEJ,QAAQ,CAAC,CAAC;AAC9E,IAAA,OAAO,MAAM;AACThB,MAAAA,WAAW,CAACmB,OAAO,CAAEC,OAAO,IAAKC,QAAQ,CAACE,mBAAmB,CAACH,OAAO,EAAEJ,QAAQ,CAAC,CAAC;IACrF,CAAC;AACL,EAAA,CAAC,EAAE,CAACN,QAAQ,EAAEC,YAAY,CAAC,CAAC;AAChC;;ACvCA,MAAMa,wBAAwB,gBAAGjC,aAAa,CAAsB,IAAI,CAAC;AAazE;AACA;AACA;AACA;AACA;AACA;AACO,MAAMkC,iBAAmD,GAAGA,CAAC;EAChE/B,QAAQ;EACRgB,QAAQ;EACRC,YAAY;AACZe,EAAAA;AACJ,CAAC,KAAK;AACF,EAAA,MAAMC,aAAa,GAAG5B,UAAU,CAACyB,wBAAwB,CAAC;AAC1D,EAAA,MAAMI,cAAc,GAAGC,OAAO,CAAC,MAAM;AACjC,IAAA,MAAMC,OAAqB,GAAG;AAC1BnB,MAAAA,YAAY,EAAE,EAAE;AAChB;AACZ;AACA;MACYoB,OAAOA,CAAC,GAAGC,eAAe,EAAE;AACxB;AACAF,QAAAA,OAAO,CAACnB,YAAY,CAACsB,IAAI,CAAC,GAAGD,eAAe,CAAC;AAE7C,QAAA,IAAIL,aAAa,EAAE;AACf;AACAA,UAAAA,aAAa,CAACI,OAAO,CAAC,GAAGC,eAAe,CAAC;AACzC,UAAA,IAAIN,SAAS,EAAE;AACX;AACAC,YAAAA,aAAa,CAACI,OAAO,CAACL,SAAS,CAAC;AACpC,UAAA;AACJ,QAAA;AACJ,MAAA;KACH;AACD,IAAA,OAAOI,OAAO;AAClB,EAAA,CAAC,EAAE,CAACH,aAAa,EAAED,SAAS,CAAC,CAAC;AAE9Bd,EAAAA,SAAS,CAAC,MAAM;IACZ,MAAM;AAAEL,MAAAA,OAAO,EAAEM;AAAY,KAAC,GAAGF,YAAY;IAC7C,IAAI,CAACE,WAAW,EAAE;AACd,MAAA;AACJ,IAAA;AACAe,IAAAA,cAAc,CAACG,OAAO,CAAC,GAAGlB,WAAW,CAAC;AAC1C,EAAA,CAAC,EAAE,CAACe,cAAc,EAAEjB,YAAY,CAAC,CAAC;AAElCF,EAAAA,YAAY,CAAC;IAAEC,QAAQ;AAAEC,IAAAA,YAAY,EAAEuB,MAAM,CAACN,cAAc,CAACjB,YAAY;AAAE,GAAC,CAAC;AAC7E,EAAA,oBAAOf,GAAA,CAAC4B,wBAAwB,CAAC3B,QAAQ,EAAA;AAACF,IAAAA,KAAK,EAAEiC,cAAe;AAAAlC,IAAAA,QAAA,EAAEA;AAAQ,GAAoC,CAAC;AACnH;AACA+B,iBAAiB,CAACU,WAAW,GAAG,mBAAmB;;AChEnD;AACA;AACA;AACA;;AAMO,MAAMC,aAAa,gBAAG9C,cAAK,CAACC,aAAa,CAAa,OAAO;EAAE8C,SAAS,EAAEhB,QAAQ,CAACiB;AAAK,CAAC,CAAC,CAAC;AAOlG;AACA;AACA;AACO,MAAMC,cAA6C,GAAGH,aAAa,CAACvC;;ACd3E;AACA;AACA;AACA;AACO,MAAM2C,MAA6B,GAAGA,CAAC;EAAE9C,QAAQ;AAAE+C,EAAAA,OAAO,GAAG;AAAK,CAAC,KAAK;AAC3E,EAAA,MAAMC,IAAI,GAAGpD,cAAK,CAACS,UAAU,CAACqC,aAAa,CAAC;AAC5C,EAAA,MAAMN,OAAO,GAAGxC,cAAK,CAACuC,OAAO,CACzB,MAAM;AACF,IAAA,OAAOY,OAAO,GAAGC,IAAI,EAAE,GAAG,IAAI;EAClC,CAAC;AACD;AACA;EACA,CAACD,OAAO,CACZ,CAAC;EAEDnD,cAAK,CAACqD,eAAe,CAAC,MAAM;IACxB,OAAOb,OAAO,EAAEc,QAAQ;EAC5B,CAAC,EAAE,CAACd,OAAO,EAAEc,QAAQ,EAAEH,OAAO,CAAC,CAAC;AAEhC,EAAA,IAAI,CAACX,OAAO,EAAEO,SAAS,EAAE;IACrB,oBAAOzC,GAAA,CAAAiD,QAAA,EAAA;AAAAnD,MAAAA,QAAA,EAAGA;AAAQ,KAAG,CAAC;AAC1B,EAAA;AACA,EAAA,oBAAOoD,YAAY,CAACpD,QAAQ,EAAEoC,OAAO,CAACO,SAAS,CAAC;AACpD;;;;"}
|
package/index.d.ts
CHANGED
|
@@ -362,6 +362,9 @@ interface BaseButtonProps extends GenericProps, Pick<AriaAttributes, 'aria-expan
|
|
|
362
362
|
* @deprecated Use Emphasis instead.
|
|
363
363
|
*/
|
|
364
364
|
declare const ButtonEmphasis: {
|
|
365
|
+
/**
|
|
366
|
+
* Component default props.
|
|
367
|
+
*/
|
|
365
368
|
readonly low: "low";
|
|
366
369
|
readonly medium: "medium";
|
|
367
370
|
readonly high: "high";
|