react-side-sheet-pro 0.1.6 → 0.1.7

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.
Files changed (7) hide show
  1. package/dist/components/SideSheetProvider.js +2 -1
  2. package/index.d.ts +11 -10
  3. package/package.json +1 -1
  4. package/src/components/SideSheetContainer.tsx +3 -3
  5. package/src/components/SideSheetProvider.tsx +3 -3
  6. package/src/contexts/SideSheetReducer.ts +4 -4
  7. package/src/types/index.ts +11 -10
package/dist/components/SideSheetProvider.js CHANGED
@@ -45,8 +45,9 @@ var SideSheetProvider = exports.SideSheetProvider = function SideSheetProvider(_
45
45
  stackRef.current = stack;
46
46
  }, [stack]);
47
47
  var open = (0, _react.useCallback)(function (element) {
48
+ var _opts$id;
48
49
  var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
49
- var id = ++idRef.current;
50
+ var id = (_opts$id = opts.id) !== null && _opts$id !== void 0 ? _opts$id : ++idRef.current;
50
51
  var options = _objectSpread(_objectSpread({}, _defaultOptions.DEFAULT_SHEET_OPTIONS), opts);
51
52
  if (!config.enableOverflow && stackRef.current.length === 0) {
52
53
  overflowRef.current = document.body.style.overflow;
package/index.d.ts CHANGED
@@ -9,6 +9,7 @@ interface SideSheetOptions {
9
9
  confirmCallback: (message: string) => Promise<boolean>;
10
10
  }
11
11
  interface SideOptions {
12
+ id?: number | string;
12
13
  width?: number;
13
14
  className?: string;
14
15
  confirmBeforeClose?: boolean;
@@ -17,27 +18,27 @@ interface SideOptions {
17
18
  closeOnOverlayClick?: boolean;
18
19
  closeOnEsc?: boolean;
19
20
  animationDuration?: number;
20
- onOpen?: (id: number) => void;
21
- onClose?: (id: number) => void;
21
+ onOpen?: (id: number | string) => void;
22
+ onClose?: (id: number | string) => void;
22
23
  }
23
24
  interface SideElementProps {
24
- sideId: number;
25
- close: (id: number | null, force?: boolean) => Promise<void>;
26
- open: (element: SideElement, options?: SideOptions) => number;
27
- update: (id: number, options: SideOptions) => void;
25
+ sideId: number | string;
26
+ close: (id: number | string | null, force?: boolean) => Promise<void>;
27
+ open: (element: SideElement, options?: SideOptions) => number | string;
28
+ update: (id: number | string, options: SideOptions) => void;
28
29
  options: SideOptions;
29
30
  }
30
31
  type SideElement = (props: SideElementProps) => ReactNode;
31
32
  interface SideStackItem {
32
- id: number;
33
+ id: number | string;
33
34
  element: SideElement;
34
35
  options: Required<SideOptions>;
35
36
  state: "opening" | "open" | "closing";
36
37
  }
37
38
  interface SideSheetContextValue {
38
- open: (el: SideElement, opts?: SideOptions) => number;
39
- close: (id: number | null, force?: boolean) => Promise<void>;
40
- update: (id: number, opts: SideOptions) => void;
39
+ open: (el: SideElement, opts?: SideOptions) => number | string;
40
+ close: (id: number | string | null, force?: boolean) => Promise<void>;
41
+ update: (id: number | string, opts: SideOptions) => void;
41
42
  config: SideSheetOptions;
42
43
  }
43
44
  declare const useSideSheet: () => SideSheetContextValue;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "react-side-sheet-pro",
3
3
  "description": "A flexible React SideSheet component for displaying contextual information.",
4
- "version": "0.1.6",
4
+ "version": "0.1.7",
5
5
  "license": "MIT",
6
6
  "keywords": [
7
7
  "react",
package/src/components/SideSheetContainer.tsx CHANGED
@@ -9,9 +9,9 @@ import {
9
9
 
10
10
  type SideSheetContainerProps = {
11
11
  stack: SideStackItem[];
12
- open: (el: SideElement, opts?: SideOptions) => number;
13
- close: (id: number | null) => Promise<void>;
14
- update: (id: number, opts: SideOptions) => void;
12
+ open: (el: SideElement, opts?: SideOptions) => number | string;
13
+ close: (id: number | string | null) => Promise<void>;
14
+ update: (id: number | string, opts: SideOptions) => void;
15
15
  config: Required<SideSheetOptions>;
16
16
  };
17
17
 
package/src/components/SideSheetProvider.tsx CHANGED
@@ -39,7 +39,7 @@ export const SideSheetProvider: React.FC<{
39
39
  }, [stack]);
40
40
 
41
41
  const open = useCallback((element: SideElement, opts: SideOptions = {}) => {
42
- const id = ++idRef.current;
42
+ const id = opts.id ?? ++idRef.current;
43
43
  const options = { ...DEFAULT_SHEET_OPTIONS, ...opts };
44
44
  if (!config.enableOverflow && stackRef.current.length === 0) {
45
45
  overflowRef.current = document.body.style.overflow;
@@ -56,7 +56,7 @@ export const SideSheetProvider: React.FC<{
56
56
  return id;
57
57
  }, []);
58
58
 
59
- const close = useCallback(async (id: number | null, force = false) => {
59
+ const close = useCallback(async (id: number | string | null, force = false) => {
60
60
  const itemsToClose =
61
61
  id === null
62
62
  ? [...stackRef.current]
@@ -93,7 +93,7 @@ export const SideSheetProvider: React.FC<{
93
93
  }, duration);
94
94
  }, []);
95
95
 
96
- const update = useCallback((id: number, options: Partial<SideOptions>) => {
96
+ const update = useCallback((id: number | string, options: Partial<SideOptions>) => {
97
97
  dispatch({ type: 'UPDATE', id, options });
98
98
  }, []);
99
99
  const config = { ...DEFAULT_OPTIONS, ...configuration } as Required<
package/src/contexts/SideSheetReducer.ts CHANGED
@@ -2,10 +2,10 @@ import { SideOptions, SideStackItem } from '../types';
2
2
 
3
3
  type Action =
4
4
  | { type: 'OPEN'; payload: SideStackItem }
5
- | { type: 'SET_OPEN'; id: number }
6
- | { type: 'CLOSE'; id: number | null }
7
- | { type: 'REMOVE'; id: number }
8
- | { type: 'UPDATE'; id: number; options: Partial<SideOptions> };
5
+ | { type: 'SET_OPEN'; id: number | string }
6
+ | { type: 'CLOSE'; id: number | string | null }
7
+ | { type: 'REMOVE'; id: number | string }
8
+ | { type: 'UPDATE'; id: number | string; options: Partial<SideOptions> };
9
9
 
10
10
  export const SideSheetReducer = (
11
11
  state: SideStackItem[],
package/src/types/index.ts CHANGED
@@ -11,6 +11,7 @@ export interface SideSheetOptions {
11
11
  }
12
12
 
13
13
  export interface SideOptions {
14
+ id?: string | number;
14
15
  width?: number;
15
16
  className?: string;
16
17
  confirmBeforeClose?: boolean;
@@ -19,30 +20,30 @@ export interface SideOptions {
19
20
  closeOnOverlayClick?: boolean;
20
21
  closeOnEsc?: boolean;
21
22
  animationDuration?: number;
22
- onOpen?: (id: number) => void;
23
- onClose?: (id: number) => void;
23
+ onOpen?: (id: number | string) => void;
24
+ onClose?: (id: number | string) => void;
24
25
  }
25
26
 
26
27
  export interface SideElementProps {
27
- sideId: number;
28
- close: (id: number | null) => Promise<void>;
29
- open: (element: SideElement, options?: SideOptions) => number;
30
- update: (id: number, options: SideOptions) => void;
28
+ sideId: number | string;
29
+ close: (id: number | string | null) => Promise<void>;
30
+ open: (element: SideElement, options?: SideOptions) => number | string;
31
+ update: (id: number | string, options: SideOptions) => void;
31
32
  options: SideOptions;
32
33
  }
33
34
 
34
35
  export type SideElement = (props: SideElementProps) => ReactNode;
35
36
 
36
37
  export interface SideStackItem {
37
- id: number;
38
+ id: number | string;
38
39
  element: SideElement;
39
40
  options: Required<SideOptions>;
40
41
  state: 'opening' | 'open' | 'closing';
41
42
  }
42
43
 
43
44
  export interface SideSheetContextValue {
44
- open: (el: SideElement, opts?: SideOptions) => number;
45
- close: (id: number | null, force: boolean) => Promise<void>;
46
- update: (id: number, opts: SideOptions) => void;
45
+ open: (el: SideElement, opts?: SideOptions) => number | string;
46
+ close: (id: number | string | null, force: boolean) => Promise<void>;
47
+ update: (id: number | string, opts: SideOptions) => void;
47
48
  config: SideSheetOptions;
48
49
  }