hisd3-ui-kit 4.1.0 → 4.2.1
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/README.md +20 -4
- package/dist/index.cjs.js +134 -62
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +24 -1
- package/dist/index.js +142 -70
- package/dist/index.js.map +1 -1
- package/package.json +7 -8
package/dist/index.d.ts
CHANGED
|
@@ -720,8 +720,21 @@ interface HISD3SidebarProps {
|
|
|
720
720
|
headerExtra?: ReactNode;
|
|
721
721
|
/** Extra items prepended to the account dropdown. */
|
|
722
722
|
userMenuItems?: MenuProps["items"];
|
|
723
|
-
/**
|
|
723
|
+
/**
|
|
724
|
+
* Where the collapse control lives:
|
|
725
|
+
* "edge" (default) floats a round chevron on the sidebar's right edge, so it
|
|
726
|
+
* works even when the top bar is hidden; "header" puts a square button in the
|
|
727
|
+
* shell's own top bar; "none" renders neither (supply your own).
|
|
728
|
+
*/
|
|
729
|
+
collapseTrigger?: "edge" | "header" | "none";
|
|
730
|
+
/** @deprecated use `collapseTrigger="none"`. */
|
|
724
731
|
hideCollapseTrigger?: boolean;
|
|
732
|
+
/**
|
|
733
|
+
* Distance in px from the top of the shell to the centre of the edge
|
|
734
|
+
* trigger. Defaults to the middle of the top bar, so it lines up with the
|
|
735
|
+
* brand block; pass a larger number to move it down.
|
|
736
|
+
*/
|
|
737
|
+
collapseTriggerOffset?: number;
|
|
725
738
|
/** Width in px of the expanded sider. Default 220. */
|
|
726
739
|
siderWidth?: number;
|
|
727
740
|
/** Disable the built-in content padding wrapper and render children directly. */
|
|
@@ -733,6 +746,13 @@ interface HISD3SidebarProps {
|
|
|
733
746
|
hideHeaderBar?: boolean;
|
|
734
747
|
/** Where the brand block links to. Default "/". */
|
|
735
748
|
brandHref?: string;
|
|
749
|
+
/**
|
|
750
|
+
* App-shell scrolling (default). The shell fills exactly one viewport and
|
|
751
|
+
* the content column scrolls inside it, so the page header stays pinned and
|
|
752
|
+
* the document cannot rubber-band ("bounce") at the top or bottom.
|
|
753
|
+
* Set to `false` to scroll the window instead, as in 4.1 and earlier.
|
|
754
|
+
*/
|
|
755
|
+
scrollContent?: boolean;
|
|
736
756
|
/**
|
|
737
757
|
* Hide the account card in the sider footer / top nav — use when the account
|
|
738
758
|
* lives in the header instead (`HISD3AvatarMenu`).
|
|
@@ -814,10 +834,13 @@ interface HISD3NotificationButtonProps {
|
|
|
814
834
|
seeAllLabel?: React.ReactNode;
|
|
815
835
|
emptyText?: React.ReactNode;
|
|
816
836
|
onOpenChange?: (open: boolean) => void;
|
|
837
|
+
/** Replace the bell glyph. Defaults to a solid bell. */
|
|
838
|
+
icon?: React.ReactNode;
|
|
817
839
|
className?: string;
|
|
818
840
|
}
|
|
819
841
|
declare const HeaderIconButton: styled_components_dist_types.IStyledComponentBase<"web", styled_components_dist_types.Substitute<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, {
|
|
820
842
|
$size?: number;
|
|
843
|
+
$open?: boolean;
|
|
821
844
|
}>> & string;
|
|
822
845
|
/** Bell button with an unread badge and a Facebook-style notifications panel. */
|
|
823
846
|
declare const HISD3NotificationButton: React.FC<HISD3NotificationButtonProps>;
|