Function default

Parameters

• props: {
      buttonCancelVariant?: "text" | "outlined" | "contained";
      buttonExportVariant?: "text" | "outlined" | "contained";
      buttonsClassName?: string;
      buttonSelectAllVariant?: "text" | "outlined" | "contained";
      buttonVariant?: "text" | "outlined" | "contained";
      buttonVariants?: "text" | "outlined" | "contained";
      children?: ReactNode;
      disableFilename?: boolean;
      disableLimit?: boolean;
      exportableData?: (
          | "Keys"
          | "VersionNodeEdge"
          | "VersionNodeChange"
          | "VersionNodeMerge"
          | "License"
          | "OneInstanceEndpoint"
          | "Email"
          | "PhoneNumber"
          | "PersonName"
          | "ProfileImage"
          | "PersonStatus"
          | "PersonImage"
          | "SignKey"
          | "EncryptionKey"
          | "OrganisationName"
          | "CreationTime"
          | "LinkedListEntry"
          | "Questionnaire_2_0_0"
          | "Questionnaire_2_1_0"
          | "Questionnaire_2_1_1"
          | "Questionnaire"
          | "QuestionnaireResponses"
          | "QuestionnaireResponses_2_0_0"
          | "WbcObservation"
          | "DocumentInfo"
          | "DocumentInfo_1_1_0"
          | "BodyTemperature"
          | "DiaryEntry"
          | "BlobCollection"
          | "BlobDescriptor"
          | "Electrocardiogram"
          | "HeartEvent"
          | "ChatMessage"
          | "ChatRequest"
          | "Topic"
          | "Consent_1_1_0"
          | "Signature"
          | "IoMRequest"
          | "AffirmationCertificate"
          | "TrustKeysCertificate"
          | "RightToDeclareTrustedKeysForEverybodyCertificate"
          | "RightToDeclareTrustedKeysForSelfCertificate"
          | "Access"
          | "Chum"
          | "Group"
          | "IdAccess"
          | "Instance"
          | "Person"
          | "Recipe"
          | "Profile"
          | "ChannelInfo"
          | "ChannelRegistry"
          | "GroupProfile"
          | "Someone"
          | "TopicAppRegistry"
      )[];
      filename?: string;
      i18n?: UseTranslationResponse<"translation", undefined>;
      limit?: number;
      onExport: (
          data: (
              | "Keys"
              | "VersionNodeEdge"
              | "VersionNodeChange"
              | "VersionNodeMerge"
              | "License"
              | "OneInstanceEndpoint"
              | "Email"
              | "PhoneNumber"
              | "PersonName"
              | "ProfileImage"
              | "PersonStatus"
              | "PersonImage"
              | "SignKey"
              | "EncryptionKey"
              | "OrganisationName"
              | "CreationTime"
              | "LinkedListEntry"
              | "Questionnaire_2_0_0"
              | "Questionnaire_2_1_0"
              | "Questionnaire_2_1_1"
              | "Questionnaire"
              | "QuestionnaireResponses"
              | "QuestionnaireResponses_2_0_0"
              | "WbcObservation"
              | "DocumentInfo"
              | "DocumentInfo_1_1_0"
              | "BodyTemperature"
              | "DiaryEntry"
              | "BlobCollection"
              | "BlobDescriptor"
              | "Electrocardiogram"
              | "HeartEvent"
              | "ChatMessage"
              | "ChatRequest"
              | "Topic"
              | "Consent_1_1_0"
              | "Signature"
              | "IoMRequest"
              | "AffirmationCertificate"
              | "TrustKeysCertificate"
              | "RightToDeclareTrustedKeysForEverybodyCertificate"
              | "RightToDeclareTrustedKeysForSelfCertificate"
              | "Access"
              | "Chum"
              | "Group"
              | "IdAccess"
              | "Instance"
              | "Person"
              | "Recipe"
              | "Profile"
              | "ChannelInfo"
              | "ChannelRegistry"
              | "GroupProfile"
              | "Someone"
              | "TopicAppRegistry"
          )[],
          options?: ExportOptions,
      ) => void | Promise<void>;
  }

  • OptionalbuttonCancelVariant?: "text" | "outlined" | "contained"

    The variant of the cancel button.

  • OptionalbuttonExportVariant?: "text" | "outlined" | "contained"

    The variant of the export button.

  • OptionalbuttonsClassName?: string

    The class name of the buttons.

  • OptionalbuttonSelectAllVariant?: "text" | "outlined" | "contained"

    The variant of the select all button.

  • OptionalbuttonVariant?: "text" | "outlined" | "contained"

    The variant of the buttons.

  • OptionalbuttonVariants?: "text" | "outlined" | "contained"

    The variants of the buttons.

  • Optionalchildren?: ReactNode

    The children to display on the button. If not provided, default text will be displayed.

  • OptionaldisableFilename?: boolean

    If true, the filename will be disabled.

  • OptionaldisableLimit?: boolean

    If true, the limit will be disabled.

  • OptionalexportableData?: (
        | "Keys"
        | "VersionNodeEdge"
        | "VersionNodeChange"
        | "VersionNodeMerge"
        | "License"
        | "OneInstanceEndpoint"
        | "Email"
        | "PhoneNumber"
        | "PersonName"
        | "ProfileImage"
        | "PersonStatus"
        | "PersonImage"
        | "SignKey"
        | "EncryptionKey"
        | "OrganisationName"
        | "CreationTime"
        | "LinkedListEntry"
        | "Questionnaire_2_0_0"
        | "Questionnaire_2_1_0"
        | "Questionnaire_2_1_1"
        | "Questionnaire"
        | "QuestionnaireResponses"
        | "QuestionnaireResponses_2_0_0"
        | "WbcObservation"
        | "DocumentInfo"
        | "DocumentInfo_1_1_0"
        | "BodyTemperature"
        | "DiaryEntry"
        | "BlobCollection"
        | "BlobDescriptor"
        | "Electrocardiogram"
        | "HeartEvent"
        | "ChatMessage"
        | "ChatRequest"
        | "Topic"
        | "Consent_1_1_0"
        | "Signature"
        | "IoMRequest"
        | "AffirmationCertificate"
        | "TrustKeysCertificate"
        | "RightToDeclareTrustedKeysForEverybodyCertificate"
        | "RightToDeclareTrustedKeysForSelfCertificate"
        | "Access"
        | "Chum"
        | "Group"
        | "IdAccess"
        | "Instance"
        | "Person"
        | "Recipe"
        | "Profile"
        | "ChannelInfo"
        | "ChannelRegistry"
        | "GroupProfile"
        | "Someone"
        | "TopicAppRegistry"
    )[]

    The data to export. If not provided, the popup will be disabled.

  • Optionalfilename?: string

    The filename to export the data as. If not provided, the default filename will be used. Also disables the filename field if not undefined.

  • Optionali18n?: UseTranslationResponse<"translation", undefined>

    The i18n instance to use. If not provided, the default i18n instance will be used.

  • Optionallimit?: number

    The limit of the data to export. If not provided, the default limit will be used. Also disables the limit field if not undefined.

  • onExport: (
        data: (
            | "Keys"
            | "VersionNodeEdge"
            | "VersionNodeChange"
            | "VersionNodeMerge"
            | "License"
            | "OneInstanceEndpoint"
            | "Email"
            | "PhoneNumber"
            | "PersonName"
            | "ProfileImage"
            | "PersonStatus"
            | "PersonImage"
            | "SignKey"
            | "EncryptionKey"
            | "OrganisationName"
            | "CreationTime"
            | "LinkedListEntry"
            | "Questionnaire_2_0_0"
            | "Questionnaire_2_1_0"
            | "Questionnaire_2_1_1"
            | "Questionnaire"
            | "QuestionnaireResponses"
            | "QuestionnaireResponses_2_0_0"
            | "WbcObservation"
            | "DocumentInfo"
            | "DocumentInfo_1_1_0"
            | "BodyTemperature"
            | "DiaryEntry"
            | "BlobCollection"
            | "BlobDescriptor"
            | "Electrocardiogram"
            | "HeartEvent"
            | "ChatMessage"
            | "ChatRequest"
            | "Topic"
            | "Consent_1_1_0"
            | "Signature"
            | "IoMRequest"
            | "AffirmationCertificate"
            | "TrustKeysCertificate"
            | "RightToDeclareTrustedKeysForEverybodyCertificate"
            | "RightToDeclareTrustedKeysForSelfCertificate"
            | "Access"
            | "Chum"
            | "Group"
            | "IdAccess"
            | "Instance"
            | "Person"
            | "Recipe"
            | "Profile"
            | "ChannelInfo"
            | "ChannelRegistry"
            | "GroupProfile"
            | "Someone"
            | "TopicAppRegistry"
        )[],
        options?: ExportOptions,
    ) => void | Promise<void>

    The function to call when the user exports the data