target-background-areas

determine support of a template for background-areas and which to use by default

Usage no npm install needed!

<script type="module">
  import targetBackgroundAreas from 'https://cdn.skypack.dev/target-background-areas';
</script>

README

target-background-areas

Build Status semantic-release

exposes targetBackgroundAreas method

which receives a DOM-node and returns a sorted array of target background-areas

taking into account:

  • default attributes
  • named background-areas
  • unnamed background-areas

falls back to body if no background-area is found

Install

npm install target-background-areas

Use

import targetBackgroundAreas from 'target-background-areas';

const backgroundAreas = targetBackgroundAreas(document);

// use the default or first background-area found
myRenderBackgroundFunc(backgroundAreas[0].node);

// use a specific background-area
const backgroundArea = backgroundAreas.find((backgroundArea) => {
    return backgroundArea.type === 'fullscreen';
});

if (backgroundArea) {
    myRenderBackgroundFunc(backgroundArea.node);
}

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.