@myunisoft/design-system 1.3.0-FT-439 → 1.3.0-ft-439
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/dist/components/Autocomplete/Autocomplete/example-usage.d.ts +4 -0
- package/dist/components/DocumentComposer/LoadingSkeleton.d.ts +2 -0
- package/dist/components/DocumentComposer/NoSectionsPlaceholder/index.d.ts +4 -0
- package/dist/components/DocumentComposer/Treeview/CustomTreeItem.d.ts +9 -0
- package/dist/components/DocumentComposer/Treeview/hooks/useTreeItemMenu.d.ts +12 -0
- package/dist/components/DocumentComposer/Treeview/index.d.ts +3 -0
- package/dist/components/DocumentComposer/Treeview/slots/IconContainerSlot.d.ts +10 -0
- package/dist/components/DocumentComposer/Treeview/slots/LabelInputSlot.d.ts +12 -0
- package/dist/components/DocumentComposer/Treeview/slots/LabelSlot.d.ts +20 -0
- package/dist/components/DocumentComposer/Treeview/slots/index.d.ts +3 -0
- package/dist/components/DocumentComposer/Treeview/types.d.ts +50 -0
- package/dist/components/DocumentComposer/components/SectionEditorPanel.d.ts +7 -0
- package/dist/components/DocumentComposer/components/index.d.ts +1 -0
- package/dist/components/DocumentComposer/hooks/useDeleteConfirmation.d.ts +12 -0
- package/dist/components/DocumentComposer/hooks/useDragVisualFeedback.d.ts +15 -0
- package/dist/components/DocumentComposer/hooks/useSectionsMap.d.ts +5 -0
- package/dist/components/DocumentComposer/hooks/useTemporarySection.d.ts +31 -0
- package/dist/components/DocumentComposer/hooks/useUnsavedChangesGuard.d.ts +19 -0
- package/dist/components/DocumentComposer/index.d.ts +6 -0
- package/dist/components/DocumentComposer/types/index.d.ts +2 -0
- package/dist/components/DocumentComposer/types/props.d.ts +69 -0
- package/dist/components/DocumentComposer/types/section.d.ts +33 -0
- package/dist/components/DocumentComposer/types.d.ts +56 -0
- package/dist/components/DocumentComposer/utils/getSectionMenuItems.d.ts +14 -0
- package/dist/components/DocumentComposer/utils/sectionHelpers.d.ts +9 -0
- package/dist/components/Export/style/index.d.ts +9 -0
- package/dist/index.js +2 -2
- package/package.json +117 -117
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
declare const BasicExample: () => import("react/jsx-runtime").JSX.Element;
|
|
2
|
+
declare const CustomOptionExample: () => import("react/jsx-runtime").JSX.Element;
|
|
3
|
+
declare const ProductExample: () => import("react/jsx-runtime").JSX.Element;
|
|
4
|
+
export { BasicExample, CustomOptionExample, ProductExample };
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { RichTreeViewProApiRef, TreeItemProps } from '@mui/x-tree-view-pro';
|
|
2
|
+
import type { TreeviewProps } from './types';
|
|
3
|
+
type TreeItemCallbacks<T extends Record<string, unknown>> = Pick<TreeviewProps<T>, 'isSectionItem' | 'isVisibleItem' | 'getIconItem' | 'hasItemMenu' | 'getMenuItems' | 'isSectionDraggable' | 'onItemVisibilityChange' | 'temporaryItem' | 'isTemporaryItem' | 'onTemporarySectionValidation' | 'onTemporarySectionCancel' | 'onItemLabelChange' | 'hiddenSectionTooltip' | 'visibleIconTooltip' | 'hiddenIconTooltip'> & {
|
|
4
|
+
apiRef: RichTreeViewProApiRef;
|
|
5
|
+
onEditingChange?: (itemId: string | null) => void;
|
|
6
|
+
};
|
|
7
|
+
type CustomTreeItemProps<T extends Record<string, unknown>> = TreeItemProps & TreeItemCallbacks<T>;
|
|
8
|
+
export declare const CustomTreeItem: <T extends Record<string, unknown>>(props: CustomTreeItemProps<T>) => import("react/jsx-runtime").JSX.Element;
|
|
9
|
+
export {};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export declare const useTreeItemMenu: () => {
|
|
2
|
+
containerRef: import("react").RefObject<HTMLLIElement | null>;
|
|
3
|
+
menuAnchorEl: HTMLElement | null;
|
|
4
|
+
menuPosition: {
|
|
5
|
+
top: number;
|
|
6
|
+
left: number;
|
|
7
|
+
} | null;
|
|
8
|
+
handleMenuClick: (event: React.MouseEvent<HTMLElement>) => void;
|
|
9
|
+
handleMenuClose: () => void;
|
|
10
|
+
scheduleMenuAction: (action: () => void) => void;
|
|
11
|
+
onMenuExited: () => void;
|
|
12
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { SxProps, Theme } from '@mui/material';
|
|
2
|
+
type IconContainerSlotProps = {
|
|
3
|
+
ownerState?: unknown;
|
|
4
|
+
children?: React.ReactNode;
|
|
5
|
+
sx?: SxProps<Theme>;
|
|
6
|
+
isDraggable?: boolean;
|
|
7
|
+
isVisible?: boolean;
|
|
8
|
+
};
|
|
9
|
+
export declare const IconContainerSlot: import("react").MemoExoticComponent<(props: IconContainerSlotProps) => import("react/jsx-runtime").JSX.Element>;
|
|
10
|
+
export {};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { InputHTMLAttributes } from 'react';
|
|
2
|
+
import type { RichTreeViewProApiRef } from '@mui/x-tree-view-pro';
|
|
3
|
+
export declare const LabelInputSlot: import("react").ForwardRefExoticComponent<InputHTMLAttributes<HTMLInputElement> & {
|
|
4
|
+
ownerState?: unknown;
|
|
5
|
+
itemId?: string;
|
|
6
|
+
isEditing?: boolean;
|
|
7
|
+
onTemporarySectionValidation?: (label: string) => void;
|
|
8
|
+
onTemporarySectionCancel?: () => void;
|
|
9
|
+
onItemLabelChange?: (itemId: string, newLabel: string) => void;
|
|
10
|
+
apiRef?: RichTreeViewProApiRef;
|
|
11
|
+
onEditingEnd?: () => void;
|
|
12
|
+
} & import("react").RefAttributes<HTMLInputElement>>;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { SxProps, Theme } from '@mui/material';
|
|
2
|
+
type LabelSlotProps = {
|
|
3
|
+
ownerState?: unknown;
|
|
4
|
+
editable?: unknown;
|
|
5
|
+
children?: React.ReactNode;
|
|
6
|
+
sx?: SxProps<Theme>;
|
|
7
|
+
customIcon?: React.ReactNode;
|
|
8
|
+
hasMenu?: boolean;
|
|
9
|
+
isVisible?: boolean;
|
|
10
|
+
isTemporary?: boolean;
|
|
11
|
+
itemId: string;
|
|
12
|
+
menuAnchorEl?: HTMLElement | null;
|
|
13
|
+
onMenuClick?: (event: React.MouseEvent<HTMLButtonElement>) => void;
|
|
14
|
+
onItemVisibilityChange?: (itemId: string, visible: boolean) => void;
|
|
15
|
+
hiddenSectionTooltip?: string;
|
|
16
|
+
visibleIconTooltip?: string;
|
|
17
|
+
hiddenIconTooltip?: string;
|
|
18
|
+
};
|
|
19
|
+
export declare const LabelSlot: import("react").MemoExoticComponent<(props: LabelSlotProps) => import("react/jsx-runtime").JSX.Element>;
|
|
20
|
+
export {};
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import type { RichTreeViewProApiRef } from '@mui/x-tree-view-pro';
|
|
2
|
+
import type { TemporarySection } from '../hooks/useTemporarySection';
|
|
3
|
+
export type ItemPositionParams = {
|
|
4
|
+
itemId: string;
|
|
5
|
+
oldPosition: {
|
|
6
|
+
parentId: string | null;
|
|
7
|
+
index: number;
|
|
8
|
+
};
|
|
9
|
+
newPosition: {
|
|
10
|
+
parentId: string | null;
|
|
11
|
+
index: number;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
export type ScheduleMenuAction = (action: () => void) => void;
|
|
15
|
+
type CustomTreeviewItemProps<T> = {
|
|
16
|
+
hasItemMenu: (item: T) => boolean;
|
|
17
|
+
getMenuItems: (item: T, scheduleMenuAction: ScheduleMenuAction) => React.ReactNode[];
|
|
18
|
+
isSectionItem: (item: T) => boolean;
|
|
19
|
+
getIconItem: (item: T) => React.ReactNode;
|
|
20
|
+
isItemEditable: (item: T) => boolean;
|
|
21
|
+
isVisibleItem: (item: T) => boolean;
|
|
22
|
+
onItemVisibilityChange: (itemId: string, visible: boolean) => void;
|
|
23
|
+
hiddenSectionTooltip?: string;
|
|
24
|
+
visibleIconTooltip?: string;
|
|
25
|
+
hiddenIconTooltip?: string;
|
|
26
|
+
};
|
|
27
|
+
export type TreeviewProps<T> = {
|
|
28
|
+
apiRef: RichTreeViewProApiRef;
|
|
29
|
+
items: readonly T[];
|
|
30
|
+
getItemId: (item: T) => string;
|
|
31
|
+
getItemLabel: (item: T) => string;
|
|
32
|
+
getItemChildren: (item: T) => T[] | undefined;
|
|
33
|
+
isSectionDraggable: (itemId: string) => boolean;
|
|
34
|
+
canMoveItemToNewPosition: (params: ItemPositionParams) => boolean;
|
|
35
|
+
onItemPositionChange: (params: ItemPositionParams) => void;
|
|
36
|
+
onItemLabelChange: (itemId: string, newLabel: string) => void;
|
|
37
|
+
temporaryItem: TemporarySection | null;
|
|
38
|
+
isTemporaryItem: (itemId: string) => boolean;
|
|
39
|
+
onTemporarySectionValidation: (label: string) => void;
|
|
40
|
+
onTemporarySectionCancel: () => void;
|
|
41
|
+
defaultExpandedItems: string[];
|
|
42
|
+
checkboxSelection?: boolean;
|
|
43
|
+
onItemSelect?: (itemId: string | null) => void;
|
|
44
|
+
} & CustomTreeviewItemProps<T>;
|
|
45
|
+
export type TreeviewItemProps<T> = {
|
|
46
|
+
itemId: string;
|
|
47
|
+
label?: React.ReactNode;
|
|
48
|
+
children?: React.ReactNode;
|
|
49
|
+
} & CustomTreeviewItemProps<T>;
|
|
50
|
+
export {};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { SectionContent } from '../types';
|
|
2
|
+
type SectionEditorPanelProps = {
|
|
3
|
+
content: SectionContent;
|
|
4
|
+
onChange: (content: SectionContent) => void;
|
|
5
|
+
};
|
|
6
|
+
export declare const SectionEditorPanel: ({ content, onChange }: SectionEditorPanelProps) => import("react/jsx-runtime").JSX.Element;
|
|
7
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { SectionEditorPanel } from './SectionEditorPanel';
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
type UseDeleteConfirmationParams = {
|
|
2
|
+
onSectionDelete?: (sectionId: string) => void;
|
|
3
|
+
/** When true, delete immediately without showing confirmation */
|
|
4
|
+
skipConfirmation?: boolean;
|
|
5
|
+
};
|
|
6
|
+
export declare const useDeleteConfirmation: ({ onSectionDelete, skipConfirmation }: UseDeleteConfirmationParams) => {
|
|
7
|
+
deleteItemId: string | null;
|
|
8
|
+
requestDelete: (sectionId: string) => void;
|
|
9
|
+
confirmDelete: () => void;
|
|
10
|
+
cancelDelete: () => void;
|
|
11
|
+
};
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { type RefObject } from 'react';
|
|
2
|
+
import type { DocumentSection } from '../types';
|
|
3
|
+
type UseDragVisualFeedbackParams = {
|
|
4
|
+
containerRef: RefObject<HTMLDivElement | null>;
|
|
5
|
+
getSectionById: (sectionId: string) => DocumentSection | null;
|
|
6
|
+
isValidDropTarget?: (draggedSection: DocumentSection, targetSection: DocumentSection | null, newIndex: number, isNesting: boolean) => boolean;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* Provides visual feedback during drag-and-drop by graying out invalid drop targets.
|
|
10
|
+
*
|
|
11
|
+
* Uses direct DOM manipulation instead of React state to avoid re-rendering
|
|
12
|
+
* all tree items on every drag event.
|
|
13
|
+
*/
|
|
14
|
+
export declare const useDragVisualFeedback: ({ containerRef, getSectionById, isValidDropTarget }: UseDragVisualFeedbackParams) => void;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { RichTreeViewProApiRef } from '@mui/x-tree-view-pro';
|
|
2
|
+
import type { DocumentSection } from '../types';
|
|
3
|
+
export type TemporarySection = Pick<DocumentSection, 'id' | 'parentId'> & {
|
|
4
|
+
parentVisible: boolean;
|
|
5
|
+
/** When undefined = editing mode (input), when defined = optimistic mode (waiting for server) */
|
|
6
|
+
title?: string;
|
|
7
|
+
};
|
|
8
|
+
type UseTemporarySectionParams = {
|
|
9
|
+
apiRef: RichTreeViewProApiRef;
|
|
10
|
+
getSectionById: (sectionId: string) => DocumentSection | null;
|
|
11
|
+
onSectionCreate?: (parentId: string | null, title: string) => string | Promise<string>;
|
|
12
|
+
scrollToBottom?: () => void;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Flow:
|
|
16
|
+
* 1. User triggers `create(parentId)` from context menu
|
|
17
|
+
* 2. A temporary section appears in the tree in edit mode (title = undefined)
|
|
18
|
+
* 3. User types a title and presses Enter → `validate()` is called
|
|
19
|
+
* - The section transitions to optimistic mode (title = defined)
|
|
20
|
+
* - Server creation is called in background
|
|
21
|
+
* 4. User presses Escape or leaves empty → `cancel()` is called
|
|
22
|
+
* 5. Server responds → temporary section is cleared, real section replaces it
|
|
23
|
+
*/
|
|
24
|
+
export declare const useTemporarySection: ({ apiRef, getSectionById, onSectionCreate, scrollToBottom }: UseTemporarySectionParams) => {
|
|
25
|
+
temporarySection: TemporarySection | null;
|
|
26
|
+
create: (parentId?: string | null) => void;
|
|
27
|
+
validate: (title: string) => void;
|
|
28
|
+
cancel: () => void;
|
|
29
|
+
isTemporary: (sectionId: string) => boolean;
|
|
30
|
+
};
|
|
31
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
type UseUnsavedChangesGuardParams = {
|
|
2
|
+
isDirty: boolean;
|
|
3
|
+
selectedSectionId?: string | null;
|
|
4
|
+
onSectionSelect?: (sectionId: string | null) => void;
|
|
5
|
+
onSave?: () => Promise<void>;
|
|
6
|
+
onDirtyReset?: () => void;
|
|
7
|
+
/** When true, navigate immediately without showing confirmation (discards changes) */
|
|
8
|
+
skipConfirmation?: boolean;
|
|
9
|
+
};
|
|
10
|
+
export declare const useUnsavedChangesGuard: ({ isDirty, selectedSectionId, onSectionSelect, onSave, onDirtyReset, skipConfirmation }: UseUnsavedChangesGuardParams) => {
|
|
11
|
+
pendingSectionId: string | null;
|
|
12
|
+
isModalOpen: boolean;
|
|
13
|
+
isSaving: boolean;
|
|
14
|
+
guardedSelect: (sectionId: string | null) => void;
|
|
15
|
+
saveAndQuit: () => Promise<void>;
|
|
16
|
+
quitWithoutSaving: () => void;
|
|
17
|
+
cancelNavigation: () => void;
|
|
18
|
+
};
|
|
19
|
+
export {};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { DocumentComposerCallbacks, DocumentComposerCustomProps, DocumentSection } from './types';
|
|
2
|
+
type DocumentComposerProps = {
|
|
3
|
+
sections?: DocumentSection[];
|
|
4
|
+
} & DocumentComposerCallbacks & DocumentComposerCustomProps;
|
|
5
|
+
declare const DocumentComposer: ({ sections, isLoadingSections, onSectionOrderChange, onSectionTitleChange, onSectionDelete, onSectionVisibilityChange, onSectionCreate, onSectionSelect, onSectionContentSave, noSectionsPlaceholder, getSectionTitleChangePermission, getSectionDeletePermission, getSectionOrderChangePermission, getSectionCreatePermission, getSectionVisibilityChangePermission, hiddenSectionTooltip, visibleIconTooltip, hiddenIconTooltip, renderSectionIcon, isValidDropTarget, sectionContent, isLoadingSectionContent, selectedSectionId, renderDeleteConfirmation, renderUnsavedChangesConfirmation }: DocumentComposerProps) => import("react/jsx-runtime").JSX.Element;
|
|
6
|
+
export default DocumentComposer;
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import type { ReactNode } from 'react';
|
|
2
|
+
import type { ItemPositionParams } from '../Treeview/types';
|
|
3
|
+
import type { DocumentSection, SectionContent } from './section';
|
|
4
|
+
export type DeleteConfirmationRenderProps = {
|
|
5
|
+
isOpen: boolean;
|
|
6
|
+
onConfirm: () => void;
|
|
7
|
+
onCancel: () => void;
|
|
8
|
+
};
|
|
9
|
+
export type UnsavedChangesRenderProps = {
|
|
10
|
+
isOpen: boolean;
|
|
11
|
+
isSaving: boolean;
|
|
12
|
+
/** True if onSectionContentSave is provided */
|
|
13
|
+
canSave: boolean;
|
|
14
|
+
onSaveAndQuit: () => void;
|
|
15
|
+
onQuitWithoutSaving: () => void;
|
|
16
|
+
onCancel: () => void;
|
|
17
|
+
};
|
|
18
|
+
export type DocumentComposerLabels = {
|
|
19
|
+
createSection?: string;
|
|
20
|
+
rename?: string;
|
|
21
|
+
delete?: string;
|
|
22
|
+
createSubsection?: string;
|
|
23
|
+
hiddenItemTooltip?: string;
|
|
24
|
+
};
|
|
25
|
+
export type DocumentComposerCustomProps = {
|
|
26
|
+
noSectionsPlaceholder?: string | ReactNode;
|
|
27
|
+
isLoadingSections?: boolean;
|
|
28
|
+
/** Defaults to `() => true` */
|
|
29
|
+
getSectionTitleChangePermission?: (section: DocumentSection) => boolean;
|
|
30
|
+
/** Defaults to `() => true` */
|
|
31
|
+
getSectionDeletePermission?: (section: DocumentSection) => boolean;
|
|
32
|
+
/** Defaults to `() => true` */
|
|
33
|
+
getSectionOrderChangePermission?: (section: DocumentSection) => boolean;
|
|
34
|
+
/** Defaults to `() => true` */
|
|
35
|
+
getSectionCreatePermission?: (section: DocumentSection) => boolean;
|
|
36
|
+
/** Defaults to `() => true` */
|
|
37
|
+
getSectionVisibilityChangePermission?: (section: DocumentSection) => boolean;
|
|
38
|
+
hiddenSectionTooltip?: string;
|
|
39
|
+
visibleIconTooltip?: string;
|
|
40
|
+
hiddenIconTooltip?: string;
|
|
41
|
+
/** Return null for no icon */
|
|
42
|
+
renderSectionIcon?: (section: DocumentSection) => ReactNode;
|
|
43
|
+
/**
|
|
44
|
+
* Determines valid drop targets during drag. Invalid targets are greyed out.
|
|
45
|
+
* `targetSection` is `null` when dropping at root level.
|
|
46
|
+
* `newIndex` is the position where the item would be inserted in the target's children.
|
|
47
|
+
* `isNesting` is `true` when the section is being moved to a new parent (dropped "on" a section),
|
|
48
|
+
* `false` when reordering within the same parent.
|
|
49
|
+
* Defaults to `() => true`.
|
|
50
|
+
*/
|
|
51
|
+
isValidDropTarget?: (draggedSection: DocumentSection, targetSection: DocumentSection | null, newIndex: number, isNesting: boolean) => boolean;
|
|
52
|
+
sectionContent?: SectionContent;
|
|
53
|
+
isLoadingSectionContent?: boolean;
|
|
54
|
+
selectedSectionId?: string | null;
|
|
55
|
+
/** If not provided, deletion proceeds without confirmation */
|
|
56
|
+
renderDeleteConfirmation?: (props: DeleteConfirmationRenderProps) => ReactNode;
|
|
57
|
+
/** If not provided, navigation proceeds without confirmation (discards changes) */
|
|
58
|
+
renderUnsavedChangesConfirmation?: (props: UnsavedChangesRenderProps) => ReactNode;
|
|
59
|
+
};
|
|
60
|
+
export type DocumentComposerCallbacks = {
|
|
61
|
+
onSectionOrderChange?: (params: ItemPositionParams) => void;
|
|
62
|
+
onSectionTitleChange?: (sectionId: string, newTitle: string) => void;
|
|
63
|
+
onSectionDelete?: (sectionId: string) => void;
|
|
64
|
+
onSectionVisibilityChange?: (sectionId: string, visible: boolean) => void;
|
|
65
|
+
onSectionCreate?: (parentId: string | null, title: string) => string | Promise<string>;
|
|
66
|
+
onSectionSelect?: (sectionId: string | null) => void;
|
|
67
|
+
/** Used by unsaved changes modal "Save and quit" action */
|
|
68
|
+
onSectionContentSave?: () => Promise<void>;
|
|
69
|
+
};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
export declare const CellFormat: {
|
|
2
|
+
readonly TEXT: "text";
|
|
3
|
+
readonly AMOUNT: "amount";
|
|
4
|
+
};
|
|
5
|
+
export type CellFormat = (typeof CellFormat)[keyof typeof CellFormat];
|
|
6
|
+
export type TableCell = {
|
|
7
|
+
value: string;
|
|
8
|
+
editable: boolean;
|
|
9
|
+
format: CellFormat;
|
|
10
|
+
};
|
|
11
|
+
export type TableRow = TableCell[];
|
|
12
|
+
export type TableValue = {
|
|
13
|
+
id: string;
|
|
14
|
+
headers: TableRow[];
|
|
15
|
+
rows: TableRow[];
|
|
16
|
+
footers: TableRow[];
|
|
17
|
+
};
|
|
18
|
+
export type TableContentBlock = {
|
|
19
|
+
type: 'table';
|
|
20
|
+
value: TableValue;
|
|
21
|
+
};
|
|
22
|
+
/** Extend this union as new content block types are added */
|
|
23
|
+
export type ContentBlock = TableContentBlock;
|
|
24
|
+
export type SectionContent = ContentBlock[];
|
|
25
|
+
export type DocumentSection = {
|
|
26
|
+
id: string;
|
|
27
|
+
title: string;
|
|
28
|
+
visible: boolean;
|
|
29
|
+
parentId: string | null;
|
|
30
|
+
type?: string;
|
|
31
|
+
hasTables?: boolean;
|
|
32
|
+
sections?: DocumentSection[] | null;
|
|
33
|
+
};
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { ItemPositionParams } from './Treeview/types';
|
|
2
|
+
export type DocumentSection = {
|
|
3
|
+
id: string;
|
|
4
|
+
title: string;
|
|
5
|
+
visible: boolean;
|
|
6
|
+
parentId: string | null;
|
|
7
|
+
sections?: DocumentSection[] | null;
|
|
8
|
+
};
|
|
9
|
+
export type DocumentComposerLabels = {
|
|
10
|
+
/** Label for the "Create section" button */
|
|
11
|
+
createSection?: string;
|
|
12
|
+
/** Label for the "Rename" menu item */
|
|
13
|
+
rename?: string;
|
|
14
|
+
/** Label for the "Delete" menu item */
|
|
15
|
+
delete?: string;
|
|
16
|
+
/** Label for the "Create subsection" menu item */
|
|
17
|
+
createSubsection?: string;
|
|
18
|
+
/** Tooltip for hidden item */
|
|
19
|
+
hiddenItemTooltip?: string;
|
|
20
|
+
};
|
|
21
|
+
export type DocumentComposerCustomProps = {
|
|
22
|
+
/** Content displayed when there are no sections */
|
|
23
|
+
noSectionsPlaceholder?: string | React.ReactNode;
|
|
24
|
+
/** Show a loading state that prevents rendering the sections */
|
|
25
|
+
isLoading?: boolean;
|
|
26
|
+
/** Returns whether section title can be edited (double-click + "Renommer" menu). Defaults to `() => true`. */
|
|
27
|
+
getSectionTitleChangePermission?: (section: DocumentSection) => boolean;
|
|
28
|
+
/** Returns whether section can be deleted ("Supprimer" menu). Defaults to `() => true`. */
|
|
29
|
+
getSectionDeletePermission?: (section: DocumentSection) => boolean;
|
|
30
|
+
/** Returns whether section can be reordered via drag & drop. Defaults to `() => true`. */
|
|
31
|
+
getSectionOrderChangePermission?: (section: DocumentSection) => boolean;
|
|
32
|
+
/** Returns whether a section can be created under this section. Defaults to `() => true`. */
|
|
33
|
+
getSectionCreatePermission?: (section: DocumentSection) => boolean;
|
|
34
|
+
/** Returns whether section visibility can be toggled. Defaults to `() => true`. */
|
|
35
|
+
getSectionVisibilityChangePermission?: (section: DocumentSection) => boolean;
|
|
36
|
+
/** Tooltip text displayed when hovering a hidden section label (visible: false) */
|
|
37
|
+
hiddenSectionTooltip?: string;
|
|
38
|
+
/** Tooltip text displayed when hovering the visibility icon of a visible section */
|
|
39
|
+
visibleIconTooltip?: string;
|
|
40
|
+
/** Tooltip text displayed when hovering the visibility icon of a hidden section */
|
|
41
|
+
hiddenIconTooltip?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Determines if `targetSection` is a valid drop location for `draggedSection`.
|
|
44
|
+
* When provided, invalid targets are visually greyed out during drag.
|
|
45
|
+
* Defaults to () => true (all targets valid).
|
|
46
|
+
* @param targetSection - The parent section where the item would be dropped, or `null` if dropping at root level.
|
|
47
|
+
*/
|
|
48
|
+
isValidDropTarget?: (draggedSection: DocumentSection, targetSection: DocumentSection | null) => boolean;
|
|
49
|
+
};
|
|
50
|
+
export type DocumentComposerCallbacks = {
|
|
51
|
+
onSectionOrderChange?: (params: ItemPositionParams) => void;
|
|
52
|
+
onSectionTitleChange?: (sectionId: string, newTitle: string) => void;
|
|
53
|
+
onSectionDelete?: (sectionId: string) => void;
|
|
54
|
+
onSectionVisibilityChange?: (sectionId: string, visible: boolean) => void;
|
|
55
|
+
onSectionCreate?: (parentId: string | null, title: string) => string | Promise<string>;
|
|
56
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { ScheduleMenuAction } from '../Treeview/types';
|
|
2
|
+
import type { DocumentSection } from '../types';
|
|
3
|
+
type MenuItemCallbacks = {
|
|
4
|
+
onRename: (sectionId: string) => void;
|
|
5
|
+
onDelete: (sectionId: string) => void;
|
|
6
|
+
onCreateSubsection: (parentId: string) => void;
|
|
7
|
+
};
|
|
8
|
+
type SectionMenuCapabilities = {
|
|
9
|
+
canRename: boolean;
|
|
10
|
+
canDelete: boolean;
|
|
11
|
+
canCreateSubsection: boolean;
|
|
12
|
+
};
|
|
13
|
+
export declare const getSectionMenuItems: (section: DocumentSection, callbacks: MenuItemCallbacks, scheduleMenuAction: ScheduleMenuAction, capabilities: SectionMenuCapabilities) => React.ReactNode[];
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { DocumentSection } from '../types';
|
|
2
|
+
export declare const getAllExpandableSectionIds: (sections: DocumentSection[]) => string[];
|
|
3
|
+
export declare const getAllSectionsFlat: (sections: DocumentSection[]) => DocumentSection[];
|
|
4
|
+
export declare const isRootSection: (section: DocumentSection) => boolean;
|
|
5
|
+
export declare const hasSectionMenu: (_section: DocumentSection) => boolean;
|
|
6
|
+
export declare const isSectionVisible: (section: DocumentSection) => boolean;
|
|
7
|
+
export declare const getSectionChildren: (section: DocumentSection) => DocumentSection[] | undefined;
|
|
8
|
+
export declare const getSectionId: (section: DocumentSection) => string;
|
|
9
|
+
export declare const getSectionTitle: (section: DocumentSection) => string;
|