@apolitical/component-library 5.4.5-SW.0 → 5.5.0

package/discussion/components/form/components/label/label.d.ts

@@ -1,13 +1,10 @@
+import { type ILabelProps } from '../../../../../form';
 import { IDiscussionContentType } from './../../../../discussion.d';
-interface Props {
-    /** The ID of the form */
-    formID: string;
+interface Props extends ILabelProps {
     /** The internationalisation path for the label */
     intlPath: string;
-    /** Whether the label should show visually */
-    showLabel: boolean;
     /** The content type */
     type: IDiscussionContentType;
 }
-declare const Label: ({ formID, intlPath, showLabel, type }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Label: ({ intlPath, type, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
 export default Label;

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

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

package/form/components/rich-text-editor/components/index.d.ts

@@ -1,3 +1,4 @@
 export * from './context';
 export * from './editor';
+export * from './label';
 export * from './toolbar';

package/form/components/rich-text-editor/components/label/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Label } from './label';
+export { type ILabelProps } from './label';

package/form/components/rich-text-editor/components/label/label.d.ts

@@ -0,0 +1,13 @@
+export interface ILabelProps {
+    /** The ID of the form */
+    formID: string;
+    /** The text to show on the label */
+    label?: {
+        visible?: string;
+        screenreader?: string;
+    };
+    /** Whether the label should show visually */
+    showLabel: boolean;
+}
+declare const Label: ({ formID, label, showLabel }: ILabelProps) => import("react/jsx-runtime").JSX.Element;
+export default Label;

package/form/components/rich-text-editor/index.d.ts

@@ -1,2 +1,3 @@
+export { Label, type ILabelProps } from './components';
 export { default as RichTextEditor } from './rich-text-editor';
 export * from './rich-text-editor.types';

package/form/types/index.d.ts

@@ -2,5 +2,6 @@ export * from './contact-form';
 export * from './invite-form';
 export * from './password-form';
 export * from './profile-form';
+export * from './publish-article-form';
 export * from './search-form';
 export * from './signup-form';

package/form/types/publish-article-form/index.d.ts

@@ -0,0 +1 @@
+export { default as PublishArticleForm } from './publish-article-form';

package/form/types/publish-article-form/publish-article-form.d.ts

@@ -0,0 +1,3 @@
+import type { IPublishArticleFormProps } from './publish-article-form.types';
+declare const PublishArticleForm: ({ id, values, functions, meta, gtm, }: IPublishArticleFormProps) => import("react/jsx-runtime").JSX.Element;
+export default PublishArticleForm;

package/form/types/publish-article-form/publish-article-form.types.d.ts

@@ -0,0 +1,39 @@
+export interface IPublishArticleFormValues {
+    title: string;
+    subtitle: string;
+    body: string;
+}
+export interface IPublishArticleFormProps {
+    /** A unique ID for the form */
+    id?: string;
+    /** Values to pre-populate the form with */
+    values?: {
+        /** The title of the form */
+        title?: string;
+        /** The subtitle of the form */
+        subtitle?: string;
+        /** The body of the form */
+        body?: string;
+    };
+    /** The functions to handle the form */
+    functions?: {
+        /** The function to publish the article */
+        create: (args: IPublishArticleFormValues) => Promise<void>;
+        /** The function called when the form is successfully published */
+        onSuccess?: (args: IPublishArticleFormValues) => void;
+        /** A function to call when there's an error with the form */
+        onFailure?: () => void;
+    };
+    /** Metadata about the form */
+    meta?: {
+        /** Whether the form is rendered in an overlay */
+        isInOverlay?: boolean;
+    };
+    /** The tracking details for GTM */
+    gtm?: {
+        /** The context for GTM */
+        context?: string;
+        /** The event for GTM */
+        event?: string;
+    };
+}

package/general/progress-tracker/index.d.ts

@@ -1 +1 @@
-export { default as ProgressTracker, type INavigationDotsProps as IProgressTrackerProps, } from './progress-tracker';
+export { default as ProgressTracker } from './progress-tracker';

package/general/progress-tracker/progress-tracker.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
-export interface INavigationDotsProps {
+interface Props {
     /** The current step */
     currentStep?: number;
     /** The total number of steps */
     steps?: number;
 }
-declare const NavigationDots: React.FC<INavigationDotsProps>;
+declare const NavigationDots: React.FC<Props>;
 export default NavigationDots;

package/helpers/intl.d.ts

@@ -272,6 +272,20 @@ export declare const checkIntlPathExists: (path: string, language?: {
     profileImageChange_cta_change: string;
     profileImageChange_cta_upload: string;
     profileImageChange_error: string;
+    publishArticleForm_title_label: string;
+    publishArticleForm_title_placeholder: string;
+    publishArticleForm_title_error: string;
+    publishArticleForm_subtitle_label: string;
+    publishArticleForm_subtitle_placeholder: string;
+    publishArticleForm_body_label: string;
+    publishArticleForm_disclaimer: string;
+    publishArticleForm_cta_submit: string;
+    publishArticleForm_cta_submitting: string;
+    publishArticleForm_cta_submitted: string;
+    publishArticleForm_aria_success: string;
+    publishArticleForm_error: string;
+    publishArticleForm_error_underMinLength: string;
+    publishArticleForm_error_loggedOut: string;
     ratings_text: string;
     ratings_stars: string;
     ratings_low: string;