@selfdecode/sd-component-library 4.0.17 → 4.0.19

package/lib/components/boxes/desktop-hidden-box/desktop-hidden-box.d.ts

@@ -3,5 +3,6 @@ import { DesktopHiddenBoxProps as Props } from "./interfaces";
 /**
  * Desktop Hidden Box component. This component, and it's children,
  *  won't be visible on desktop screens
+ *  @deprecated use useBreakPoints() hook instead
  */
 export declare const DesktopHiddenBox: React.FC<Props>;

package/lib/components/boxes/mobile-hidden-box/mobile-hidden-box.d.ts

@@ -3,5 +3,6 @@ import { MobileHiddenBoxProps as Props } from "./interfaces";
 /**
  * Mobile Hidden Box component. This component, and it's children,
  * won't be visible on mobile screens
+ * @deprecated use useBreakPoints() hook instead
  */
 export declare const MobileHiddenBox: React.FC<Props>;

package/lib/components/containers/grid-containers/base-grid-container/base-grid-container.d.ts

@@ -2,5 +2,6 @@ import React from "react";
 import { BaseGridContainerProps } from "./interfaces";
 /**
  * Base grid container component.
+ * @deprecated use Grid instead
  */
 export declare function BaseGridContainer(props: BaseGridContainerProps): React.ReactElement<BaseGridContainerProps>;

package/lib/components/containers/max-width-container/max-width-container.d.ts

@@ -1,3 +1,6 @@
 import React from "react";
 import { MaxWidthContainerProps as Props } from "./interfaces";
+/**
+ * @deprecated in most of the case MaxWidth would be preferable
+ */
 export declare const MaxWidthContainer: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLDivElement>>;

package/lib/components/meters/compact-donut-gauge/compact-donut-gauge.d.ts

@@ -1,3 +1,3 @@
-import React from "react";
+import React, { PropsWithChildren } from "react";
 import { CompactDonutGaugeProps as Props } from "./interfaces";
-export declare const CompactDonutGauge: React.FC<Props>;
+export declare const CompactDonutGauge: React.FC<PropsWithChildren<Props>>;

package/lib/components/meters/donut-diagram/interfaces.d.ts

@@ -20,5 +20,6 @@ export interface DonutSegment {
     end: number;
     text: string;
     color: string;
+    secondaryText?: string;
 }
 export declare type DonutSegmentLabelPosition = "left" | "right";

package/lib/components/selectors/compact-primary-selector/compact-primary-selector.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import { CompactPrimarySelectorProps as Props } from "./interfaces";
+/**
+ * @deprecated is preferred to use V2 or custom selector instead
+ */
 export declare const CompactPrimarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;

package/lib/components/selectors/primary-selector/primary-selector.d.ts

@@ -2,5 +2,6 @@
 import { PrimarySelectorProps as Props } from "./interfaces";
 /**
  * The PrimarySelector.
+ * @deprecated use PrimarySelectorV2 instead
  */
 export declare const PrimarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;

package/lib/components/selectors/secondary-selector/secondary-selector.d.ts

@@ -2,5 +2,6 @@
 import { SecondarySelectorProps as Props } from "./interfaces";
 /**
  * The SecondarySelector.
+ * @deprecated use SecondarySelectorV2 instead
  */
 export declare const SecondarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;

package/lib/components/selectors/selector/selector.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { SelectorProps as Props } from "./interfaces";
 export declare const getNoTranslateClass: (flag: boolean) => "no-translate" | undefined;
+/**
+ * @deprecated use SelectorV2 instead
+ */
 export declare const Selector: <T extends string = string>(props: Props<T>) => JSX.Element;

package/lib/components/selectors/tertiary-selector/tertiary-selector.d.ts

@@ -2,5 +2,6 @@
 import { TertiarySelectorProps as Props } from "./interfaces";
 /**
  * The TertiarySelector.
+ * @deprecated use TertiarySelectorV2 instead
  */
 export declare const TertiarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;

package/lib/components/texts/base-text/base-text.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import { BaseTextProps } from "./interfaces";
+/**
+ * @deprecated use BaseTextV2 instead
+ */
 export declare const BaseText: (props: BaseTextProps) => JSX.Element;

package/lib/components/texts/responsive-text/responsive-text.d.ts

@@ -4,5 +4,6 @@ import { ResponsiveTextProps } from "./interfaces";
  * Component for use in cases
  * where the fontSize and fontWeight change between breakpoints.
  * @param props.fontSizeWeight format: [fontSize, fontWeight][]
+ * @deprecated use ResponsiveTextV2 instead
  */
 export declare const ResponsiveText: React.FunctionComponent<ResponsiveTextProps>;

package/lib/components/utils/anchor/anchor.d.ts

@@ -4,4 +4,4 @@ import { AnchorProps } from "./interfaces";
  * Anchor component. This component allows scrolling to the components
  * when window hash is changed.
  */
-export declare const Anchor: React.FunctionComponent<AnchorProps>;
+export declare const Anchor: React.FC<AnchorProps>;

package/lib/components/utils/anchor/interfaces.d.ts

@@ -18,7 +18,7 @@ export interface AnchorProps extends BoxProps, ScrollIntoViewOptions {
      * This function (if present) will be called when the child component
      * is scrolled to top of the screen.
      */
-    onScrolledToTop?: () => void;
+    onScrolledToTop?: (id: string) => void;
     /**
      * Scroll offset adjust to take fixed navbars into account when checking
      * if element has reached to the top of window.