@apolitical/component-library 5.0.0 → 5.0.1-jc.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/components/likes/likes-modal.d.ts

@@ -0,0 +1,25 @@
+import { MemberProps } from '../../../user';
+import { IBadgesOption } from '../../../user/badges';
+export interface ILikesModalProps {
+    /** Whether the modal is open on page load */
+    showModal?: boolean;
+    /** The number of likes */
+    likes?: number;
+    /** Information about the people who have liked the content */
+    peopleWhoLiked?: false | MemberProps[];
+    /** The ID of the post to show likes for */
+    postId?: string;
+    /** Whether to show badges and the scope of the badge */
+    badges?: IBadgesOption;
+    /** The ID of the comment to show likes for */
+    commentId?: string;
+    /** Functions used inside the modal */
+    functions: {
+        /** Function to call when the modal is closed */
+        onClose?: () => void;
+    };
+    /** Additional classes */
+    className?: string;
+}
+declare const LikesModal: ({ showModal, functions: modalFunctions, peopleWhoLiked, badges, likes, className, }: ILikesModalProps) => import("react/jsx-runtime").JSX.Element;
+export default LikesModal;

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/general/link/link.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-interface Props {
+export interface ILinkProps {
     /** URL for link */
     href?: string | undefined;
     /** Content to rendered */
@@ -33,5 +33,5 @@ interface Props {
     /** Data attributes for the link */
     'data-before'?: string;
 }
-declare const Link: ({ href, children, fallbackElement, className, onClick, gtmContext, gtmType, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Link: ({ href, children, fallbackElement, className, onClick, gtmContext, gtmType, ...props }: ILinkProps) => import("react/jsx-runtime").JSX.Element;
 export default Link;

package/general/tooltip/index.d.ts

@@ -1 +1,2 @@
 export { default as Tooltip } from './tooltip';
+export * from './tooltip-linkset.hook';

package/general/tooltip/tooltip-linkset.hook.d.ts

@@ -0,0 +1 @@
+export declare function useTooltipLinkset(setTooltipLink: (index: number) => void): (e: React.KeyboardEvent<HTMLElement> | undefined) => void;

package/general/tooltip/tooltip.d.ts

@@ -28,8 +28,13 @@ interface Props {
         /** The callback to fire when the tooltip is closed */
         onClose?: () => void;
     };
-    /** Whether the tooltip is hidden from screen readers or not */
-    'aria-hidden'?: boolean;
+    /** Optional props for accessibility */
+    accessibility?: {
+        /** Whether this should use `hidden` on content, or if screenreaders should be able to access the full text, even when the tooltip is closed, e.g. for tooltips on buttons and pills */
+        readToScreenreadersWhenClosed?: boolean;
+        /** Whether the tooltip is hidden from screen readers or not */
+        'aria-hidden'?: boolean;
+    };
     /** The id of the tooltip */
     id?: string;
 }

package/helpers/intl.d.ts

@@ -38,9 +38,12 @@ export declare const checkIntlPathExists: (path: string, language?: {
     card_cta_event_done: string;
     card_cta_microcourse_done: string;
     carousel_pagination_previous: string;
+    carousel_pagination_previousSlide: string;
     carousel_pagination_next: string;
-    carousel_pagination_page: string;
-    carousel_pagination_aria_live: string;
+    carousel_pagination_nextSlide: string;
+    carousel_pagination_slide: string;
+    carousel_pagination_ariaLive: string;
+    carousel_pagination_ariaLive_slide: string;
     activitySection_notFoundError: string;
     activitiesFeed_sorting_label: string;
     activitiesFeed_rankingMethod_recent: string;
@@ -50,6 +53,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     communityDetails_viewAll: string;
     communityDetails_invite: string;
     community_joinToPost: string;
+    community_sortSuccess: string;
     joinCommunityButton: string;
     joinCommunityButton_short: string;
     joinCommunityButton_joining: string;
@@ -150,7 +154,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussion_form_explainer_question: string;
     discussion_likes: string;
     discussion_likes_short: string;
-    discussion_likes_more: string;
+    discussion_likes_showAll: string;
     discussion_likes_like: string;
     discussion_likes_unlike: string;
     discussion_likes_show: string;