@apolitical/component-library 1.5.0 → 1.6.0

package/communities/community-details/community-details.d.ts

@@ -1,7 +1,17 @@
+import { MemberProps } from '../../user';
 import { IJoinButtonProps } from './../join-button';
 interface Props extends IJoinButtonProps {
+    /** If the user is a member of the community */
+    isMember?: boolean;
+    /** The slug for the community */
+    slug: string;
+    /** Details about members in the community */
+    members?: {
+        number?: number | undefined;
+        data?: MemberProps[];
+    };
     /** Additional classes */
     className?: string;
 }
-declare const CommunityDetails: ({ className, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const CommunityDetails: ({ isMember, slug, members: { number, data: members }, className, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
 export default CommunityDetails;

package/communities/index.d.ts

@@ -1,2 +1,3 @@
 export * from './community-details';
 export * from './join-button';
+export * from './members-list';

package/communities/join-button/join-button.d.ts

@@ -1,6 +1,8 @@
 export interface IJoinButtonProps {
     /** If the user is a member of the community */
     isMember?: boolean;
+    /** If the button should use the short version of the text */
+    isShort?: boolean;
     /** The function to call when the user clicks the button */
     functions?: {
         /** The function to request to join */
@@ -11,5 +13,5 @@ export interface IJoinButtonProps {
     /** The language to use */
     locale?: string;
 }
-declare const JoinButton: ({ isMember: userIsMember, functions: { join, leave } }: IJoinButtonProps) => import("react/jsx-runtime").JSX.Element;
+declare const JoinButton: ({ isMember: userIsMember, isShort, functions: { join, leave } }: IJoinButtonProps) => import("react/jsx-runtime").JSX.Element;
 export default JoinButton;

package/communities/members-list/index.d.ts

@@ -0,0 +1 @@
+export { default as MembersList } from './members-list';

package/communities/members-list/members-list.d.ts

@@ -0,0 +1,23 @@
+import { PaginationType } from '../../navigation';
+import { MemberDetailsProps } from '../../user';
+interface CommunityMemberProps extends MemberDetailsProps {
+    /** Whether the user is an admin of the community or not */
+    isAdmin?: boolean;
+}
+interface Props {
+    /** Details about members in the community */
+    members: {
+        total?: number | undefined;
+        data?: CommunityMemberProps[];
+    };
+    /** Details for the pagination */
+    pagination?: PaginationType;
+    /** The GTM context to use */
+    gtmContext?: string;
+    /** The GTM event to use */
+    gtmType?: string;
+    /** Additional classes */
+    className?: string;
+}
+declare const MembersList: ({ members: { total, data: members }, pagination, gtmContext, gtmType, className, }: Props) => import("react/jsx-runtime").JSX.Element | null;
+export default MembersList;

package/discussion/likes/likes.d.ts

@@ -1,10 +1,13 @@
 import React from 'react';
+import { MemberProps } from '../../user';
 import { IDiscussionContent } from './../discussion';
 interface Props {
     /** The element to render around the content */
-    element?: 'span' | 'p' | 'li' | 'div';
+    element?: 'li' | 'div';
     /** The number of likes the content has had */
     likes?: number;
+    /** Information about the people who have liked the content */
+    peopleWhoLiked?: false | MemberProps[];
     /** If we should display the short version */
     isShort?: boolean;
     /** Whether the user has liked the content */
@@ -13,16 +16,23 @@ interface Props {
     content?: IDiscussionContent;
     /** If the user is able to like the content (e.g. they can't like their own content) */
     canLike?: boolean;
-    /** Function to create a like */
-    createLike?: (args1: object, args2: object) => void;
-    /** Function to delete a like */
-    deleteLike?: (args: object) => void;
+    /** Functions to handle liking and unliking */
+    functions?: {
+        /** Function to create a like */
+        createLike?: (args1: object, args2: object) => void;
+        /** Function to delete a like */
+        deleteLike?: (args: object) => void;
+    };
     /** The language to use for the text */
     locale?: string;
 }
-declare const Likes: ({ element, likes, isShort, userLiked, content, canLike, createLike, deleteLike, }: Props) => React.DetailedReactHTMLElement<{
+declare const Likes: ({ element, likes, peopleWhoLiked, isShort, userLiked, content, canLike, functions: { createLike, deleteLike } }: Props) => React.DetailedReactHTMLElement<{
     className: string;
     onClick: (e: React.MouseEvent<HTMLElement>) => false | undefined;
+    onMouseEnter: () => void;
+    onMouseLeave: () => void;
+    onFocus: () => void;
+    onBlur: () => void;
     children: import("react/jsx-runtime").JSX.Element;
 }, HTMLElement>;
 export default Likes;

package/discussion/likes/likes.helpers.d.ts

@@ -1,3 +1,4 @@
+import { MemberProps } from '../../user';
 export declare const createSlugsPayload: ({ question, answer, reply, }: {
     question?: string | undefined;
     answer?: string | undefined;
@@ -7,3 +8,4 @@ export declare const createSlugsPayload: ({ question, answer, reply, }: {
     answerSlug?: string | undefined;
     questionSlug?: string | undefined;
 };
+export declare const getTooltipContent: (peopleWhoLiked: false | MemberProps[], cutoff?: number) => MemberProps[];

package/discussion/post/post.d.ts

@@ -30,8 +30,11 @@ interface Props {
             openComments: () => void;
         };
     };
-    /** Optional `href` for the card to link to */
-    link?: string;
+    /** Optional `href`s for the card to link to */
+    links?: {
+        post?: string;
+        comments?: string;
+    };
     /** Additional classes */
     className?: string;
     /** The GTM context */
@@ -41,5 +44,5 @@ interface Props {
     /** The language for the text */
     locale?: string;
 }
-declare const Post: ({ element, content, isLoading, originalAuthorId, functions: { content: { createContent, deleteContent, updateContent }, likes: { createLike, deleteLike }, comments: { openComments }, }, link, className, gtmContext, locale, children, }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Post: ({ element, content, isLoading, originalAuthorId, functions: { content: { createContent, deleteContent, updateContent }, likes: { createLike, deleteLike }, comments: { openComments }, }, links, className, gtmContext, locale, children, }: Props) => import("react/jsx-runtime").JSX.Element;
 export default Post;

package/general/index.d.ts

@@ -2,3 +2,4 @@ export * from './buttons';
 export * from './divider';
 export * from './link';
 export * from './responsive-image';
+export * from './tooltip';

package/general/link/link.d.ts

@@ -7,7 +7,7 @@ interface Props {
     /** Additonal classes */
     className?: string;
     /** Function to be called when clicked */
-    onClick?: (e?: React.MouseEvent<HTMLElement>) => void;
+    onClick?: ((e?: React.MouseEvent<HTMLElement>) => void) | undefined;
     /** GTM event context */
     gtmContext?: string;
     /** GTM event type */

package/general/tooltip/index.d.ts

@@ -0,0 +1 @@
+export { default as Tooltip } from './tooltip';

package/general/tooltip/tooltip.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+interface Props {
+    /** If the tooltip is open or not */
+    isOpen?: boolean;
+    /** If the content is loading or not */
+    isLoading?: boolean;
+    /** The content to show in the tooltip */
+    children?: React.ReactNode | JSX.Element | string;
+}
+declare const Tooltip: ({ isOpen, isLoading, children }: Props) => import("react/jsx-runtime").JSX.Element;
+export default Tooltip;

package/helpers/index.d.ts

@@ -3,5 +3,6 @@ export * from './breakpoints';
 export * from './dates';
 export { default as delay } from './delay';
 export * from './intl';
+export * from './numbers';
 export { default as passPropsToChildren } from './pass-props-to-children';
 export * from './validation';

package/helpers/numbers.d.ts

@@ -0,0 +1 @@
+export declare const shortenNumber: (number: number, decimalPlaces?: number, abbreviations?: string[]) => string;

package/hooks/index.d.ts

@@ -2,3 +2,4 @@ export { default as useEffectAfterMount } from './use-effect-after-mount';
 export { default as useFeatureFlag } from './use-feature-flag';
 export { default as useScreenWidth } from './use-screen-width';
 export { default as useScrollListener } from './use-scroll-listener';
+export { default as useScrollToHash } from './use-scroll-to-hash';

package/hooks/use-scroll-to-hash.d.ts

@@ -0,0 +1,2 @@
+declare function _default(dependencies?: any[], isSmooth?: boolean): void;
+export default _default;