@scrippsproduct/networks-ui-library 1.0.15 → 1.0.16

package/dist/components/ActionButton/ActionButton.d.ts

@@ -1,19 +1,22 @@
-export function ActionButton({ label, type, onClick, varient, size, customColors, disabled, classname, ...attributes }: {
-    [x: string]: any;
-    label: any;
-    type?: string | undefined;
-    onClick?: (() => void) | undefined;
-    varient?: string | undefined;
-    size?: string | undefined;
-    customColors?: {
-        bgColor: string;
-        bgHoverColor: string;
-        color: string;
-        hoverColor: string;
-        borderColor: string;
-        borderHoverColor: string;
-    } | undefined;
-    disabled: any;
-    classname?: string | undefined;
-}): import("react/jsx-runtime").JSX.Element;
+/**
+ * ActionButton component for rendering a button that will display a loading state.
+ * @param {*} param0 - Component props.
+ * @param {string} param0.label - The text label for the button.
+ * @param {string} param0.type - The type of button (default is 'button').
+ * @param {function} param0.onClick - The click handler function for the button.
+ * @param {string} param0.varient - The style variant of the button (default is '').
+ * @param {string} param0.size - The size of the button (default is '').
+ * @param {object} param0.customColors - Custom colors for the button.
+ * @param {string} param0.customColors.bgColor - Background color of the button.
+ * @param {string} param0.customColors.bgHoverColor - Background color on hover.
+ * @param {string} param0.customColors.color - Text color of the button.
+ * @param {string} param0.customColors.hoverColor - Text color on hover.
+ * @param {string} param0.customColors.borderColor - Border color of the button.
+ * @param {string} param0.customColors.borderHoverColor - Border color on hover.
+ * @param {boolean} param0.disabled - Whether the button is disabled (default is false).
+ * @param {string} param0.classname - Additional CSS classes for the button.
+ * @param {object} param0.attributes - Additional attributes to be applied to the button.
+ * @returns {JSX.Element} The rendered action button.
+ */
+export function ActionButton({ label, type, onClick, varient, size, customColors, disabled, classname, ...attributes }: any): JSX.Element;
 export default ActionButton;

package/dist/components/AdBlock/AdBlock.d.ts

@@ -1,6 +1,10 @@
-export function AdBlock({ image, ad, theme }: {
-    image: any;
-    ad: any;
-    theme?: string | undefined;
-}): import("react/jsx-runtime").JSX.Element;
+/**
+ * AdBlock component for rendering an advertisement block with various themes.
+ * @param {*} param0 - Component props.
+ * @param {Object} param0.image - The image object containing the ad image URL and alt text.
+ * @param {Object} param0.ad - The ad object containing campaign, source, medium, content, header, description, linkText, and href.
+ * @param {string} [param0.theme='default'] - The theme to apply to the ad block (default is 'default').
+ * @returns {JSX.Element} The rendered ad block.
+ */
+export function AdBlock({ image, ad, theme }: any): JSX.Element;
 export default AdBlock;

package/dist/components/AdjustableTwoColumnGrid/AdjustableTwoColumnGrid.d.ts

@@ -1,7 +1,11 @@
-export function AdjustableTwoColumnGrid({ children, gap, firstColumnWidth, classname }: {
-    children: any;
-    gap?: string | undefined;
-    firstColumnWidth?: number | undefined;
-    classname?: string | undefined;
-}): import("react/jsx-runtime").JSX.Element;
+/**
+ * AdjustableTwoColumnGrid component for rendering a two-column layout with adjustable widths.
+ * @param {*} param0 - Component props.
+ * @param {React.ReactNode} param0.children - The child components to be rendered in the two columns.
+ * @param {string} [param0.gap='1.5rem'] - The gap size between the columns.
+ * @param {number|string} [param0.firstColumnWidth=33] - The width of the first column, can be a percentage or pixel value.
+ * @param {string} [param0.classname=''] - Additional CSS classes for the layout.
+ * @returns {JSX.Element} The rendered two-column layout.
+ */
+export function AdjustableTwoColumnGrid({ children, gap, firstColumnWidth, classname }: any): JSX.Element;
 export default AdjustableTwoColumnGrid;

package/dist/components/AnchorTag/AnchorTag.d.ts

@@ -1,9 +1,7 @@
-export function AnchorTag({ href, classname, label, type, image, clickHandler }: {
-    href?: string | undefined;
-    classname?: string | undefined;
-    label?: string | undefined;
-    type?: string | undefined;
-    image?: null | undefined;
-    clickHandler?: null | undefined;
-}): import("react/jsx-runtime").JSX.Element;
+/**
+ * AnchorTag component for rendering anchor links with optional image support.
+ * @param {*} param0 - Component props.
+ * @returns {JSX.Element} The rendered anchor tag.
+ */
+export function AnchorTag({ href, classname, label, type, image, clickHandler }: any): JSX.Element;
 export default AnchorTag;

package/dist/components/DrawerNavigation/DrawerNavigation.d.ts

@@ -1,10 +1,7 @@
-export function DrawerNavigation({ links, items, classname, logo, clipPathStart, clipPathEnd, overlayAppendEl }: {
-    links?: never[] | undefined;
-    items?: never[] | undefined;
-    classname?: string | undefined;
-    logo?: {} | undefined;
-    clipPathStart?: string | undefined;
-    clipPathEnd?: string | undefined;
-    overlayAppendEl?: Element | null | undefined;
-}): import("react/jsx-runtime").JSX.Element;
+/**
+ * DrawerNavigation component for rendering a drawer-style navigation menu.
+ * @param {*} param0 - Component props.
+ * @returns {JSX.Element} The rendered drawer navigation.
+ */
+export function DrawerNavigation({ links, items, classname, logo, clipPathStart, clipPathEnd, overlayAppendEl }: any): JSX.Element;
 export default DrawerNavigation;

package/dist/components/FindUs/FindUs.d.ts

@@ -1,20 +1,23 @@
-export function FindUs({ network, baseApiUrl, platformsApiUrl, authApiUrl, allowStateSearch, allowZipcodeSearch, allowAutoScroll, autoScrollOffset, compactLayout, showChannelSearchAndRescan, numberOfColumns, ad }: {
-    network: any;
-    baseApiUrl: any;
-    platformsApiUrl?: string | undefined;
-    authApiUrl?: string | undefined;
-    allowStateSearch?: boolean | undefined;
-    allowZipcodeSearch?: boolean | undefined;
-    allowAutoScroll?: boolean | undefined;
-    autoScrollOffset?: number | undefined;
-    compactLayout?: boolean | undefined;
-    showChannelSearchAndRescan?: boolean | undefined;
-    numberOfColumns: any;
-    ad?: {
-        campaign: string;
-        source: string;
-        medium: string;
-        content: string;
-    } | undefined;
-}): import("react/jsx-runtime").JSX.Element;
+/**
+ * FindUs component for rendering the "Find Us" section.
+ * @param {*} param0 - Component props.
+ * @param {Object} param0.network - The network object containing platform information.
+ * @param {string} param0.baseApiUrl - The base API URL for fetching data.
+ * @param {string} [param0.platformsApiUrl='https://api.scrippscloud.com/viewing-platforms/v1'] - The API URL for fetching viewing platforms.
+ * @param {string} [param0.authApiUrl=''] - The API URL for authentication.
+ * @param {boolean} [param0.allowStateSearch=true] - Whether to allow state search.
+ * @param {boolean} [param0.allowZipcodeSearch=true] - Whether to allow zipcode search.
+ * @param {boolean} [param0.allowAutoScroll=true] - Whether to allow auto-scrolling.
+ * @param {number} [param0.autoScrollOffset=25] - The offset for auto-scrolling.
+ * @param {boolean} [param0.compactLayout=true] - Whether to use a compact layout.
+ * @param {boolean} [param0.showChannelSearchAndRescan=true] - Whether to show the channel search and rescan section.
+ * @param {number} [param0.numberOfColumns] - The number of columns for the device and platform lists.
+ * @param {Object} [param0.ad] - The ad object containing campaign, source, medium, and content.
+ * @param {string} [param0.ad.campaign=''] - The ad campaign.
+ * @param {string} [param0.ad.source=''] - The ad source.
+ * @param {string} [param0.ad.medium='referral'] - The ad medium.
+ * @param {string} [param0.ad.content='learn_more'] - The ad content.
+ * @returns {JSX.Element} The rendered "Find Us" section.
+ */
+export function FindUs({ network, baseApiUrl, platformsApiUrl, authApiUrl, allowStateSearch, allowZipcodeSearch, allowAutoScroll, autoScrollOffset, compactLayout, showChannelSearchAndRescan, numberOfColumns, ad }: any): JSX.Element;
 export default FindUs;

package/dist/hooks/useSourcepointPrivacyTrigger.d.ts

@@ -1,4 +1,10 @@
 export default useSourcePointPrivacyTrigger;
-declare function useSourcePointPrivacyTrigger({ messageId }: {
-    messageId?: number | undefined;
-}): null;
+/**
+ * Custom hook to trigger the Sourcepoint privacy manager modal.
+ * @param {*} param0 - Configuration object.
+ * @param {number} param0.messageId - The message ID to load in the privacy manager modal.
+ * Defaults to 1192723.
+ *
+ * @returns void
+ */
+declare function useSourcePointPrivacyTrigger({ messageId }: any): null;

package/dist/settings.d.ts

@@ -1,3 +1,3 @@
 export const slideLayoutsMap: Map<string, import('react').LazyExoticComponent<typeof import('.').FigureSlide>>;
 export const pageHeroLayoutsMap: Map<string, import('react').LazyExoticComponent<typeof import('./components/PageHero/page-hero-layouts').IONShowHero>>;
-export const blockLayoutsMap: Map<string, import('react').LazyExoticComponent<typeof import('.').AdBlock>>;
+export const blockLayoutsMap: Map<string, import('react').LazyExoticComponent<typeof import('.').CtaBlock>>;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.15",
+  "version": "1.0.16",
   "name": "@scrippsproduct/networks-ui-library",
   "description": "React Component Library for use in Scripps Networks external applications",
   "author": {