@selfdecode/sd-component-library 4.0.16 → 4.0.18

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.
@@ -3,5 +3,6 @@ import { DesktopHiddenBoxProps as Props } from "./interfaces";
3
3
  /**
4
4
  * Desktop Hidden Box component. This component, and it's children,
5
5
  * won't be visible on desktop screens
6
+ * @deprecated use useBreakPoints() hook instead
6
7
  */
7
8
  export declare const DesktopHiddenBox: React.FC<Props>;
@@ -3,5 +3,6 @@ import { MobileHiddenBoxProps as Props } from "./interfaces";
3
3
  /**
4
4
  * Mobile Hidden Box component. This component, and it's children,
5
5
  * won't be visible on mobile screens
6
+ * @deprecated use useBreakPoints() hook instead
6
7
  */
7
8
  export declare const MobileHiddenBox: React.FC<Props>;
@@ -2,5 +2,6 @@ import React from "react";
2
2
  import { BaseGridContainerProps } from "./interfaces";
3
3
  /**
4
4
  * Base grid container component.
5
+ * @deprecated use Grid instead
5
6
  */
6
7
  export declare function BaseGridContainer(props: BaseGridContainerProps): React.ReactElement<BaseGridContainerProps>;
@@ -1,3 +1,6 @@
1
1
  import React from "react";
2
2
  import { MaxWidthContainerProps as Props } from "./interfaces";
3
+ /**
4
+ * @deprecated in most of the case MaxWidth would be preferable
5
+ */
3
6
  export declare const MaxWidthContainer: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLDivElement>>;
@@ -1,3 +1,6 @@
1
1
  /// <reference types="react" />
2
2
  import { CompactPrimarySelectorProps as Props } from "./interfaces";
3
+ /**
4
+ * @deprecated is preferred to use V2 or custom selector instead
5
+ */
3
6
  export declare const CompactPrimarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;
@@ -2,5 +2,6 @@
2
2
  import { PrimarySelectorProps as Props } from "./interfaces";
3
3
  /**
4
4
  * The PrimarySelector.
5
+ * @deprecated use PrimarySelectorV2 instead
5
6
  */
6
7
  export declare const PrimarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;
@@ -2,5 +2,6 @@
2
2
  import { SecondarySelectorProps as Props } from "./interfaces";
3
3
  /**
4
4
  * The SecondarySelector.
5
+ * @deprecated use SecondarySelectorV2 instead
5
6
  */
6
7
  export declare const SecondarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;
@@ -1,4 +1,7 @@
1
1
  /// <reference types="react" />
2
2
  import { SelectorProps as Props } from "./interfaces";
3
3
  export declare const getNoTranslateClass: (flag: boolean) => "no-translate" | undefined;
4
+ /**
5
+ * @deprecated use SelectorV2 instead
6
+ */
4
7
  export declare const Selector: <T extends string = string>(props: Props<T>) => JSX.Element;
@@ -2,5 +2,6 @@
2
2
  import { TertiarySelectorProps as Props } from "./interfaces";
3
3
  /**
4
4
  * The TertiarySelector.
5
+ * @deprecated use TertiarySelectorV2 instead
5
6
  */
6
7
  export declare const TertiarySelector: <T extends string = string>(props: Props<T>) => JSX.Element;
@@ -1,3 +1,6 @@
1
1
  /// <reference types="react" />
2
2
  import { BaseTextProps } from "./interfaces";
3
+ /**
4
+ * @deprecated use BaseTextV2 instead
5
+ */
3
6
  export declare const BaseText: (props: BaseTextProps) => JSX.Element;
@@ -4,5 +4,6 @@ import { ResponsiveTextProps } from "./interfaces";
4
4
  * Component for use in cases
5
5
  * where the fontSize and fontWeight change between breakpoints.
6
6
  * @param props.fontSizeWeight format: [fontSize, fontWeight][]
7
+ * @deprecated use ResponsiveTextV2 instead
7
8
  */
8
9
  export declare const ResponsiveText: React.FunctionComponent<ResponsiveTextProps>;
@@ -4,4 +4,4 @@ import { AnchorProps } from "./interfaces";
4
4
  * Anchor component. This component allows scrolling to the components
5
5
  * when window hash is changed.
6
6
  */
7
- export declare const Anchor: React.FunctionComponent<AnchorProps>;
7
+ export declare const Anchor: React.FC<AnchorProps>;
@@ -18,7 +18,7 @@ export interface AnchorProps extends BoxProps, ScrollIntoViewOptions {
18
18
  * This function (if present) will be called when the child component
19
19
  * is scrolled to top of the screen.
20
20
  */
21
- onScrolledToTop?: () => void;
21
+ onScrolledToTop?: (id: string) => void;
22
22
  /**
23
23
  * Scroll offset adjust to take fixed navbars into account when checking
24
24
  * if element has reached to the top of window.