Norwegian Parcel Mail

    mirador-share-plugin

    0.11.0 • Public • Published

    Mirador Share Plugin

    Travis npm package

    mirador-share-plugin is a Mirador 3 plugin that adds the several options for sharing a resource to the window options menu. Options include specifying embedded <iframe> options and a preferred share link.

    share-button-in-menu

    sharing options window - share link, iframe, and drag and drop

    Installation

    mirador-share-plugin requires an instance of Mirador 3. See the Mirador wiki for examples of embedding Mirador within an application and additional information about plugins. See the live demo's index.js for an example of importing and configuring mirador-share-plugin.

    Configuration

    Configurations for this plugin are injected when Mirador is initialized under the miradorSharePlugin key.

    ...
      id: 'mirador',
      miradorSharePlugin: {
        ...
      }
    ...
    Config Key Type Description
    dragAndDropInfoLink string/url Provides a What is IIIF link under the Alternate Viewers / Drag & Drop that points to the configured URL. This will also be the base of the Drag & Drop link so that if a user clicks instead of drags, they will go the informational page (as opposed to the manifest which is the default behavior)
    embedOption object The configuration objects for the Embed section. You can use this if you're able to easily modify the manifest ID to a URL that can be used to embed the resource in an <iframe> (most likely in embedded mode where you're only displaying your own content)
    embedOption.enabled boolean Configure whether to render the Embed section in the Share Dialog.
    embedOption.embedIframeAttributes string A string that contains HTML attributes to be applied to the <iframe> embed code. (Default: allowfullscreen frameborder="0")
    embedOption.embedIframeTitle string A string to be used as the title element of the <iframe> embed code. (Default: "Image viewer")
    embedOption.embedUrlReplacePattern array An array that represents the two options to the javascript string replace function. When embedOption.enabled is true this config will be used to modify the manifestId prop (using the replace function) to generate the url that will be used as the src of the <iframe> embed code.
    embedOption.syncIframeDimensions object Provide this configuration object to sync particular <iframe> size dimensions to Embed URL parameters. Example: syncIframeDimensions: { height: { param: 'maxheight' } } will attach a maxheight parameter to the URL in the <iframe> embed code. Supported dimensions are height and width.
    shareLink object The configuration objects for the Share link section. You can use this if you're able to easily modify the manifest ID to the link to the resource (most likely in embedded mode where you're only displaying your own content)
    shareLink.enabled boolean Configure whether to render the Share link section in the Share Dialog.
    shareLink.manifestIdReplacePattern array An array that represents the two options to the javascript string replace function. When shareLink.enabled is true this config will be used to modify the manifestId prop (using the replace function) to generate the share link.

    Contribute

    Mirador's development, design, and maintenance is driven by community needs and ongoing feedback and discussion. Join us at our regularly scheduled community calls, on IIIF slack #mirador, or the mirador-tech and iiif-discuss mailing lists. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.

    Install

    npm i mirador-share-plugin

    DownloadsWeekly Downloads

    369

    Version

    0.11.0

    License

    Apache-2.0

    Unpacked Size

    3.24 MB

    Total Files

    18

    Last publish

    Collaborators

    • budak
    • marlo-longley
    • corylown
    • mejackreed
    • aeschylus
    • jessie.keck
    • cbeer
    • lutzhelm
    • camillevilla