dmp-template-data

component to analyze template DOM

Install

npm install dmp-template-data

Usage

// import every function
import * as templateData from 'dmp-template-data';

// import partials of the component
import { hasBackgroundArea } from 'dmp-template-data';

API

templateData.metaTagValue(dom, name)

• dom < Document Object >
• name< String >

The templateData.metaTagValue function returns the content of requested meta tag.

For example:

templateData.metaTagValue(document, 'jimdo.version')

templateData.hasMetaTag(dom, name)

• dom < Document Object >
• name< String >

The templateData.hasMetaTag function returns true if requested meta tag exists.

For example:

templateData.hasMetaTag(document, 'jimdo.version')

templateData.hasBackgroundArea(dom)

• dom < Document Object >

The templateData.hasBackgroundArea function returns true if background area has been enabled.

For example:

templateData.hasBackgroundArea(document)

templateData.placeholdersFor(dom, type)

• dom < Document Object >
• type < String >

The templateData.placeholdersFor function returns an array of requested placeholders as HTML nodes.

For example:

templateData.placeholdersFor(document, 'content')

templateData.getVariations(dom)

• dom < Document Object >

It returns an array of the variations.

For example:

templateData.getVariations(document)

// return => [{ name: 'Variation', file: 'beautiful.css', color: 'red'}]

Contribution

# get repo
git clone git@github.com:Jimdo/dmp-template-data.git
cd dmp-template-data

# dependencies
npm i

# run unit tests
npm test

License

The MIT License

Copyright (C) 2016 Jimdo GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.