@jonz94/capacitor-image-picker/dist/docs.json

Capacitor plugin for multiple image selection

{
  "api": {
    "name": "ImagePickerPlugin",
    "slug": "imagepickerplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "present",
        "signature": "(options?: PresentOptions | undefined) => Promise<Images>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "PresentOptions | undefined"
          }
        ],
        "returns": "Promise<Images>",
        "tags": [],
        "docs": "",
        "complexTypes": [
          "Images",
          "PresentOptions"
        ],
        "slug": "present"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "Images",
      "slug": "images",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "images",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "Array of all the picked images.",
          "complexTypes": [
            "Image"
          ],
          "type": "Image[]"
        }
      ]
    },
    {
      "name": "Image",
      "slug": "image",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "path",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "The file path of the image.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "webPath",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "webPath returns a path that can be used to set the src attribute of an image for efficient\nloading and rendering.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "mimeType",
          "tags": [
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "The mime type of the image.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "PresentOptions",
      "slug": "presentoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "limit",
          "tags": [
            {
              "text": "1",
              "name": "default"
            },
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "Maximum number of images the user will be able to choose.\n\nNote: If this is set to 1, upon selection of a single image.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "surpassLimitMessage",
          "tags": [
            {
              "text": "\"You can only select %d images.\"",
              "name": "default"
            },
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "The message when user select more than maximum number of pictures. This message will not occur when `limit` is 1.\n\nNote: The message **MUST INCLUDE ONE AND ONLY ONE `%d`** as a placeholder for showing the value of `limit`.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "titleText",
          "tags": [
            {
              "text": "\"Select Image\"",
              "name": "default"
            },
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "Android only: The title of the image picker.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "albumAllText",
          "tags": [
            {
              "text": "\"All\"",
              "name": "default"
            },
            {
              "text": "1.2.0",
              "name": "since"
            }
          ],
          "docs": "Android only: name of the all photos album.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "libraryTitleText",
          "tags": [
            {
              "text": "\"Library\"",
              "name": "default"
            },
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "iOS only: The title of the library.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "albumsTitleText",
          "tags": [
            {
              "text": "\"Albums\"",
              "name": "default"
            },
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "iOS only: The title of the albums.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "cancelText",
          "tags": [
            {
              "text": "\"Cancel\"",
              "name": "default"
            },
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "iOS only: The text to display on the cancel button.\n\nNote: on Android, the cancel button is shown as icon-only back button with no text.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "doneText",
          "tags": [
            {
              "text": "\"Done\"",
              "name": "default"
            },
            {
              "text": "1.0.0",
              "name": "since"
            }
          ],
          "docs": "The text to display on the done button.",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}