Decapod 0.7 Export User Interface Configuration

Owned by Justin Obara
Last updated: Nov 30, 2012Version comment
3 min read

Creation

Method

decapod.exporter(container, options);

Description

Instantiates the exporter component, which is the top level component for the PDF and Image Conversion page.

Parameters

container
A CSS-based selectors, single-element jQuery object, or DOM element that identifies the root DOM node where the Exporter should be placed

options
An optional data structure that configures the Exporter component

Returns

The Exporter component

Examples

 
var exporter = decapod.exporter("#myContainer", {
    selectors: {
        title: ".mySelector"
    }
});

Component Selectors

Selectors

Some information about selectors and how they can be configured can be found here: Component Configuration Options - Selectors

title

Description

The element that will be used to display the main title for the exporter. This should be an <h1> when Exporter is the only component on the page.

Default

".dc-exporter-title"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        title: ".myTitle"
    }
});

formats

Description

The element that will be used to display a message describing the contents of exporter or some instructions at the top level.

Default

".dc-exporter-formats"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        formats: ".myFormats"
    }
});

help

Description

The element used to refer to the help documentation. Should be an <a> with the url to the help page.

Default

".dc-exporter-help"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myHelp"
    }
});

uploadClear

Description

The element used to refresh the page. Likely an <a>.

Default

".dc-exporter-uploadClear"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myUploadClear"
    }
});

uploadContainer

Description

The element used to house the uploader component. The necessary markup will be injected here.

Default

".dc-exporter-upload"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myUploadContainer"
    }
});

uploadBrowse

Description

The element used to trigger the browsing of files to be upload. Activating this will launch the browser file system dialog.

Default

".dc-exporter-uploadBrowse"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myUploadBrowse"
    }
});

importStatusContainer

Description

The element used to house the import status component. The necessary markup will be injected here.

Default

".dc-exporter-importStatus"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myImportStatusContainer"
    }
});

instructions

Description

The element used to display initial instruction text for uploading files.

Default

".dc-exporter-instructions"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myInstructions"
    }
});

pdfs

Description

The element used to display the heading for the PDF export types.

Default

".dc-exporter-pdfs"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myPDFs"
    }
});

images

Description

The element used to display the heading for the image export types.

Default

".dc-exporter-images"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myImages"
    }
});

accordionContainer

Description

The element used as the container for the accordion. This is what manages the hiding and showing of the options for the various export types. Therefore the export types must be contained within it.

Default

".dc-exporter-accordion"

Example

 
decapod.exporter(".myContainer", {
    selectors: {
        help: ".myAccordionContainer"
    }
});

Styles

busy

Description

The css class used to apply the busy styling to the page. (e.g. change to the wait cursor)

Default

"ds-shared-busy"

Example

 
decapod.exporter(".myContainer", {
    styles: {
        busy: "myBusyClass"
    }
});

See the Decapod Styling guide for information on changing the appearance of Decapod.