@apolitical/component-library 4.8.0 → 4.8.1-SW.0

package/cards/card-block/card-block.d.ts

@@ -1,5 +1,5 @@
 import { CardType, CardContentType, BuildCardDataType } from '../../cards/cards.types';
-interface Props {
+export interface ICardBlockProps {
     /** The card data, from Contentful */
     cards: CardType[];
     /** The types for each card, from Contentful */
@@ -12,5 +12,5 @@ interface Props {
     className?: string;
     focusCardIndex?: number;
 }
-declare const CardBlock: ({ cards, cardTypes, className, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const CardBlock: ({ cards, cardTypes, className, ...props }: ICardBlockProps) => import("react/jsx-runtime").JSX.Element;
 export default CardBlock;

package/cards/card-block/index.d.ts

@@ -1 +1,2 @@
+export type { ICardBlockProps } from './card-block';
 export { default as CardBlock } from './card-block';

package/discussion/sections/activity-section/activity-section.d.ts

@@ -6,7 +6,7 @@ import { type IQueryFns } from './cache';
 interface IActivitySectionQueryFns extends IQueryFns {
     remove: () => Promise<void>;
 }
-interface Props {
+export interface IActivitySectionProps {
     basePath: string;
     parentId: string;
     activityId: string;
@@ -21,5 +21,5 @@ interface Props {
     };
     profile: IProfileFormProps;
 }
-declare const ActivitySection: React.FC<Props>;
+declare const ActivitySection: React.FC<IActivitySectionProps>;
 export default ActivitySection;

package/discussion/sections/activity-section/index.d.ts

@@ -1 +1,2 @@
+export type { IActivitySectionProps } from './activity-section';
 export { default as ActivitySection } from './activity-section';

package/form/components/form/index.d.ts

@@ -1,2 +1,2 @@
 export { default as Form } from './form';
-export type { IField, FormValues, IFormMeta } from './form.types';
+export type { IField, FormValues, IFormMeta, IFormProps } from './form.types';

package/form/types/profile-form/profile-form.d.ts

@@ -1,5 +1,5 @@
 import type { IFormValues, IFormMeta } from './../../components/form/form.types';
-export interface IProfileFormProps {
+export interface IProfileFormProps<OnSuccessArgs = IFormValues> {
     /** The hooks used in the form */
     hooks: {
         /** The hook to predict the user's location */
@@ -16,9 +16,9 @@ export interface IProfileFormProps {
     /** The functions to call */
     functions: {
         /** The function to upload the user's profile image */
-        uploadImage: () => Promise<void>;
+        uploadImage: () => Promise<unknown>;
         /** The function to call on success */
-        onSuccess?: (data: IFormValues) => Promise<void>;
+        onSuccess?: (data: OnSuccessArgs) => Promise<void>;
         /** The function to call when the form is cancelled, e.g. the user presses a cancel button */
         onCancel?: () => void;
         /** The function to call on failure */

package/layout/content-layout/columns/columns.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-interface Props {
+export interface IColumnsProps {
     /** The layout for the columns */
     layout?: '2-1' | '1-3' | '1-1';
     /** If the columns should be hidden until they'd show in a row */
@@ -11,5 +11,5 @@ interface Props {
     /** The content to be rendered */
     children: React.ReactElement;
 }
-declare const Columns: ({ layout, hideOnMobile, hasCSSContainers, className, children, }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Columns: ({ layout, hideOnMobile, hasCSSContainers, className, children, }: IColumnsProps) => import("react/jsx-runtime").JSX.Element;
 export default Columns;

package/layout/content-layout/columns/index.d.ts

@@ -1 +1,2 @@
+export type { IColumnsProps } from './columns';
 export { default as Columns } from './columns';

package/navigation/load-more/index.d.ts

@@ -1,2 +1,2 @@
-export type { PaginationType } from './load-more';
+export type { ILoadMoreProps, PaginationType } from './load-more';
 export { default as LoadMore } from './load-more';

package/navigation/load-more/load-more.d.ts

@@ -13,13 +13,13 @@ export interface PaginationType {
         error: string;
     };
 }
-interface Props extends PaginationType {
+export interface ILoadMoreProps extends PaginationType {
     /** Additional classes  */
     className?: string;
     /** GTM event context */
     gtmContext?: string;
 }
-interface Props extends ButtonPropsType {
+export interface ILoadMoreProps extends ButtonPropsType {
 }
-declare const LoadMore: ({ hasNextPage, loadNextPage, isLoading, variant, size, styling, icon, messages, className, gtmContext, }: Props) => import("react/jsx-runtime").JSX.Element | null;
+declare const LoadMore: ({ hasNextPage, loadNextPage, isLoading, variant, size, styling, icon, messages, className, gtmContext, }: ILoadMoreProps) => import("react/jsx-runtime").JSX.Element | null;
 export default LoadMore;

package/navigation/tabs/index.d.ts

@@ -1 +1,2 @@
+export type { ITabsProps, ITab, ITabBreakPoint } from './tabs';
 export { default as Tabs } from './tabs';

package/navigation/tabs/tabs.d.ts

@@ -1,9 +1,9 @@
 import React from 'react';
-interface TabBreakPoint {
+export interface ITabBreakPoint {
     target: 'min-width' | 'max-width';
     value: number;
 }
-interface TabType {
+export interface ITab {
     /** An ID for the tab - this is used to create an anchor on the page */
     id?: string;
     /** The text to show for the tab */
@@ -17,15 +17,15 @@ interface TabType {
     /** Whether the tab has carousels - this is needed to ensure the carousel width loads as expected */
     hasCarousel?: boolean;
     /** The breakpoint at which the tab should be shown. If not specified, always show */
-    breakpoint?: TabBreakPoint;
+    breakpoint?: ITabBreakPoint;
 }
-interface Props {
+export interface ITabsProps {
     /** The tab details */
-    tabs: TabType[];
+    tabs: ITab[];
     /** Additional classes */
     className?: string;
     /** Prevent window move by not jumping to the tab on click */
     preventLocationChange?: boolean;
 }
-declare const Tabs: ({ tabs, className, preventLocationChange }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Tabs: ({ tabs, className, preventLocationChange }: ITabsProps) => import("react/jsx-runtime").JSX.Element;
 export default Tabs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/component-library",
-  "version": "4.8.0",
+  "version": "4.8.1-SW.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/sections/edit-section/edit-section.d.ts

@@ -9,7 +9,7 @@ interface IPlaceholder {
     /** Cta message showing on a button */
     ctaMessage?: string;
 }
-interface Props {
+export interface IEditSectionProps {
     /** Additional classes */
     className?: string;
     /** Content to be rendered */
@@ -33,5 +33,5 @@ interface Props {
     /** Placeholder settings */
     placeholder?: IPlaceholder;
 }
-declare const EditSection: ({ children, className, formProps, formComponent: originalFormComponent, href, title, showTitle, modalTitle, placeholder, showDivider, }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const EditSection: ({ children, className, formProps, formComponent: originalFormComponent, href, title, showTitle, modalTitle, placeholder, showDivider, }: IEditSectionProps) => import("react/jsx-runtime").JSX.Element;
 export default EditSection;

package/sections/edit-section/index.d.ts

@@ -1 +1,2 @@
+export type { IEditSectionProps } from './edit-section';
 export { default as EditSection } from './edit-section';

package/text/empty-state-box/empty-state-box.d.ts

@@ -7,7 +7,7 @@ interface ButtonType extends ButtonPropsType {
     };
     component?: React.ReactNode;
 }
-interface Props {
+export interface IEmptyStateBoxProps {
     /** Box styling */
     variant?: 'empty' | 'error';
     /** Optional text */
@@ -17,5 +17,5 @@ interface Props {
     /** Additional classes */
     className?: string;
 }
-declare const EmptyStateBox: ({ variant, text, button, className, }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const EmptyStateBox: ({ variant, text, button, className, }: IEmptyStateBoxProps) => import("react/jsx-runtime").JSX.Element;
 export default EmptyStateBox;

package/text/empty-state-box/index.d.ts

@@ -1 +1,2 @@
+export type { IEmptyStateBoxProps } from './empty-state-box';
 export { default as EmptyStateBox } from './empty-state-box';

package/text/hide-show-text-box/hide-show-text-box.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { MarkdownToJSX } from 'markdown-to-jsx';
-interface Props {
+export interface IHideShowTextBoxProps {
     /** The language for the box text */
     locale?: string;
     /** An optional id for the box */
@@ -16,5 +16,5 @@ interface Props {
     markdownOptions?: MarkdownToJSX.Options;
     children?: React.ReactNode;
 }
-declare const HideShowTextBox: ({ id, className, show, hide, text, markdownOptions, children, }: Props) => import("react/jsx-runtime").JSX.Element | null;
+declare const HideShowTextBox: ({ id, className, show, hide, text, markdownOptions, children, }: IHideShowTextBoxProps) => import("react/jsx-runtime").JSX.Element | null;
 export default HideShowTextBox;

package/text/hide-show-text-box/index.d.ts

@@ -1 +1,2 @@
+export type { IHideShowTextBoxProps } from './hide-show-text-box';
 export { default as HideShowTextBox } from './hide-show-text-box';

package/text/highlighted-text-box/highlighted-text-box.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-interface Props {
+export interface IHighlightedTextBoxProps {
     /** The style of box being rendered */
     variant?: 'primary' | 'secondary' | 'tertiary' | 'quaternary' | 'subtle' | 'subtle-alt' | 'bold' | 'muted';
     /** The name of an icon file to display at the top */
@@ -18,5 +18,5 @@ interface Props {
     /** Additional props to pass to the box */
     style?: React.CSSProperties;
 }
-declare const HighlightedTextBoxWrapper: ({ variant, icon, styling, className, children, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const HighlightedTextBoxWrapper: ({ variant, icon, styling, className, children, ...props }: IHighlightedTextBoxProps) => import("react/jsx-runtime").JSX.Element;
 export default HighlightedTextBoxWrapper;

package/text/highlighted-text-box/index.d.ts

@@ -1 +1,2 @@
+export type { IHighlightedTextBoxProps } from './highlighted-text-box';
 export { default as HighlightedTextBox } from './highlighted-text-box';

package/user/profile-picture/index.d.ts

@@ -1 +1,2 @@
+export type { IProfilePictureProps } from './profile-picture';
 export { default as ProfilePicture } from './profile-picture';

package/user/profile-picture/profile-picture.d.ts

@@ -1,4 +1,4 @@
-interface Props {
+export interface IProfilePictureProps {
     /** The user's name, to create initials */
     name: string;
     /** The user's image */
@@ -16,5 +16,5 @@ interface Props {
     /** Optional test ID */
     'data-testid'?: string;
 }
-declare const ProfilePicture: ({ className, src, name, alt, width, height, showInitials, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const ProfilePicture: ({ className, src, name, alt, width, height, showInitials, ...props }: IProfilePictureProps) => import("react/jsx-runtime").JSX.Element;
 export default ProfilePicture;