@oneblink/apps-react 13.0.0-beta.1 → 13.0.0-beta.11

package/dist/OneBlinkFormBase.d.ts

@@ -3,7 +3,7 @@ import { submissionService, attachmentsService } from './apps';
 import { EnvironmentTypes, FormTypes, FormsAppsTypes, ScheduledTasksTypes, SubmissionTypes } from '@oneblink/types';
 import { ReplaceInjectablesOverrides } from './hooks/useReplaceInjectablesOverrides';
 import { CaptchaType, ExecutedLookups, SetFormSubmission, SectionState } from './types/form';
-export type OneBlinkReadOnlyFormProps = {
+type OneBlinkFormDisplayProps = {
     /**
      * A [Google Maps API
      * Key](https://developers.google.com/maps/documentation/javascript/get-api-key).
@@ -40,7 +40,27 @@ export type OneBlinkReadOnlyFormProps = {
      */
     audience: FormTypes.FormElementHiddenFromAudience;
 };
-export type OneBlinkFormBaseProps = OneBlinkReadOnlyFormProps & {
+export type OneBlinkReadOnlyFormProps = OneBlinkFormDisplayProps & ((OneBlinkFormControlledProps & {
+    /**
+     * Element ids that remain editable. All other elements are read-only.
+     * Requires the same controlled submission props as
+     * `OneBlinkFormControlled`.
+     */
+    editableFormElementIds: string[];
+    form?: never;
+    initialSubmission?: never;
+}) | (OneBlinkFormUncontrolledProps & {
+    /** Omit to render every form element as read-only. */
+    editableFormElementIds?: never;
+    definition?: never;
+    submission?: never;
+    setFormSubmission?: never;
+    lastElementUpdated?: never;
+    executedLookups?: never;
+    sectionState?: never;
+}));
+export type OneBlinkFormBaseProps = OneBlinkFormDisplayProps & {
+    editableFormElementIds?: string[];
     /** The function to call when the user cancels the form */
     onCancel: () => unknown;
     /**
@@ -162,6 +182,6 @@ export type OneBlinkFormControlledProps = {
 type Props = OneBlinkFormBaseProps & OneBlinkFormControlledProps & {
     isReadOnly: boolean;
 };
-declare function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captchaSiteKey, definition, disabled, isPreview, submission, isReadOnly, onCancel, onSubmit, onSaveDraft, setFormSubmission, buttons, validationIcon, primaryColour, attachmentRetentionInDays, isPendingQueueEnabled, handleNavigateAway, isInfoPage: isInfoPageProp, lastElementUpdated, executedLookups, task, taskGroup, taskGroupInstance, onUploadAttachment, captchaType, shouldUseNavigableValidationErrorsNotification, navigableValidationErrorsNotificationSettings, replaceInjectablesOverrides, sectionState, scrollToTopOfPage, getCurrentSubmissionDuration, onBeforeUnload, audience, }: Props): import("react/jsx-runtime").JSX.Element;
+declare function OneBlinkFormBase({ googleMapsApiKey, abnLookupAuthenticationGuid, captchaSiteKey, definition, disabled, isPreview, submission, isReadOnly, onCancel, onSubmit, onSaveDraft, setFormSubmission, buttons, validationIcon, primaryColour, attachmentRetentionInDays, isPendingQueueEnabled, handleNavigateAway, isInfoPage: isInfoPageProp, lastElementUpdated, executedLookups, task, taskGroup, taskGroupInstance, onUploadAttachment, captchaType, shouldUseNavigableValidationErrorsNotification, navigableValidationErrorsNotificationSettings, replaceInjectablesOverrides, sectionState, scrollToTopOfPage, getCurrentSubmissionDuration, onBeforeUnload, audience, editableFormElementIds, }: Props): import("react/jsx-runtime").JSX.Element;
 declare const _default: React.MemoExoticComponent<typeof OneBlinkFormBase>;
 export default _default;