{"_id":"@aurolabs/aurolabs-background","_rev":"6-fc44f59e8e73d5f19ac86f537aa79dd9","name":"@aurolabs/aurolabs-background","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"//":["================================================================================","# To work within the development environment, run the following tasks","  1. $ npm run dev","  2. $ npm run serve","  3. Go to http://localhost:8000","================================================================================"],"name":"@aurolabs/aurolabs-background","version":"1.0.0","description":"aurolabs-background HTML custom element","repository":{"type":"git","url":"git+https://github.com/AlaskaAirlines/aurolabs-background.git"},"main":"index.js","license":"Apache-2.0","dependencies":{"chalk":"^4.1.1","lit-element":"^2.5.1"},"peerDependencies":{"@alaskaairux/design-tokens":"^3.2.1","@alaskaairux/webcorestylesheets":"^3.4.0","@webcomponents/webcomponentsjs":"^2.5.0","focus-visible":"^5.2.0"},"devDependencies":{"@alaskaairux/design-tokens":"^3.2.1","@alaskaairux/webcorestylesheets":"^3.4.0","@aurodesignsystem/eslint-config":"^1.0.0","@babel/core":"^7.14.3","@babel/plugin-syntax-dynamic-import":"^7.8.3","@babel/plugin-transform-runtime":"^7.14.3","@babel/preset-env":"^7.14.2","@babel/runtime":"^7.14.0","@commitlint/cli":"^12.1.4","@commitlint/config-conventional":"^12.1.4","@open-wc/testing":"^2.5.33","@rollup/plugin-alias":"^3.1.2","@rollup/plugin-babel":"^5.3.0","@rollup/plugin-commonjs":"^19.0.0","@rollup/plugin-node-resolve":"^13.0.0","@semantic-release/changelog":"^5.0.1","@semantic-release/git":"^9.0.0","@semantic-release/npm":"^7.1.3","@web/dev-server":"^0.1.17","@web/test-runner":"^0.13.4","@webcomponents/webcomponentsjs":"^2.5.0","autoprefixer":"^10.2.5","babel-loader":"^8.2.2","compression":"^1.7.4","concat":"^1.0.3","copyfiles":"^2.4.1","core-js":"^3.12.1","eslint":"^7.26.0","eslint-plugin-lit":"^1.4.1","focus-visible":"^5.2.0","husky":"^4.3.8","lodash":"^4.17.21","marked":"^2.0.4","nodemon":"^2.0.7","npm-run-all":"^4.1.5","postcss":"^8.3.0","postcss-custom-properties":"^11.0.0","postcss-discard-comments":"^5.0.1","postcss-rem-to-pixel":"^4.1.2","postcss-remove-rules":"^1.0.0","postcss-selector-replace":"^1.0.2","prismjs":"^1.23.0","rollup":"^2.48.0","rollup-plugin-minify-html-literals":"^1.2.6","rollup-plugin-serve":"^1.1.0","rollup-plugin-terser":"^7.0.2","sass":"^1.33.0","semantic-release":"^17.4.3","stylelint":"^13.13.1","stylelint-config-idiomatic-order":"^8.1.0","stylelint-config-standard":"^22.0.0","stylelint-order":"^4.1.0","stylelint-scss":"^3.19.0","wc-sass-render":"^1.2.3","web-component-analyzer":"^1.1.6","whatwg-fetch":"^3.6.2","yaml-lint":"^1.2.4"},"browserslist":["last 2 Chrome versions","last 2 iOS major versions","ie 11","last 2 Firefox versions","last 2 Edge versions","last 2 Safari major versions"],"nodemonConfig":{"ignore":["*-css.js","*.css"]},"husky":{"hooks":{"commit-msg":"commitlint -E HUSKY_GIT_PARAMS"}},"release":{"branches":["main"],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator",["@semantic-release/changelog",{"changelogFile":"./CHANGELOG.md","changelogTitle":"# Semantic Release Automated Changelog"}],"@semantic-release/npm",["@semantic-release/git",{"assets":["./CHANGELOG.md","package.json"]}],"@semantic-release/github"]},"commitlint":{"extends":["@commitlint/config-conventional"]},"publishConfig":{"access":"public"},"keywords":["alaska airlines","auro","design system","web components"],"scripts":{"build":"npm-run-all build:sass sass:render linters dist:js build:api bundler postinstall test","build:ci":"npm-run-all sweep build","build:api":"wca analyze 'src/auro-background.js' --outFiles docs/api.md","build:demo":"npm-run-all build demo:rm:build demo:new:build demo:copy:index demo:copy:demo demo:update:index","build:dev:assets":"npm-run-all build:sass:demo build:sass:component postCss:component sass:render build:api","build:sass":"npm-run-all build:sass:demo build:sass:component postCss:component sass:render","build:sass:demo":"sass demo:demo","build:sass:component":"sass src:src","build:watch":"nodemon -e scss,js --watch src --exec npm run build:dev:assets","bundler":"rollup -c","bundler:test":"rollup -c -w","scssLint":"stylelint \"./src/**/*.scss\"","demo:copy:demo":"copyfiles -u 1 -V './demo/demo.md' ./build/demo","demo:copy:index":"copyfiles -u 1 -V './demo/index.html' ./build","demo:new:build":"mkdir ./build && mkdir ./build/css && mkdir ./build/demo","demo:rm:build":"rm -rf ./build","demo:update:index":"node ./scripts/prepForBuild","dev":"npm run build:watch","dist:js":"copyfiles -u 1 -V './src/**/*.js' ./dist","esLint":"eslint src/auro-*.js","linters":"npm-run-all scssLint esLint","postCss:component":"node ./scripts/postCss.js","postinstall":"node packageScripts/postinstall.js","sass:render":"sass-render src/*.css -t ./scripts/staticStyles-template.js","serve":"web-dev-server --open demo/ --node-resolve --watch","sweep":"rm -rf ./demo/css ./dist | rm ./src/*.css ./src/*-css.js","test":"wtr --coverage","test:watch":"wtr --watch"},"gitHead":"e5a0107fd7e39cfa88bfa5dda8d08c9fb94999b3","bugs":{"url":"https://github.com/AlaskaAirlines/aurolabs-background/issues"},"homepage":"https://github.com/AlaskaAirlines/aurolabs-background#readme","_id":"@aurolabs/aurolabs-background@1.0.0","_nodeVersion":"14.17.0","_npmVersion":"6.14.13","dist":{"integrity":"sha512-LxcWR+lAtcWLykuOZQE/iOcCXSopFf5YHN3xOY15bAZ700KxtKNdgOuF9i+WhiG2zxJ5OWgBfrsYMIV41NFbpw==","shasum":"a1a66c0cc726fb392deee741d73e172ffc54f326","tarball":"https://registry.npmjs.org/@aurolabs/aurolabs-background/-/aurolabs-background-1.0.0.tgz","fileCount":14,"unpackedSize":321648,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh12E3CRA9TVsSAnZWagAAIdkP/2M6nOzi7tKZAjXLGIAB\nxdU4U0Rw21mMobRFiMAnOsFs1V1Z8TLSBfuSqg4V+MUnykqj0ZAP4PnasELA\n2Q2qWKGSOSuew5ExdZlUASuFgwg6lTv1S/gjjX7N3E34adwYqgFqH///2XSv\nYJ4v/fPqSvMOlopjyGfhSFROBaOmEkqqqvSdvwdc9UIJFLhzSQxnGGEFE3O/\n2PMfJEKGi/uH1qsvmV0WfGOBwudfQBe5GVmMyG5orZMnejpfWtDL/xifoU08\nljSSsujIyfW2g8IeE7ThV8FZZiXL+JhphVHc3QQvWfjoYIZPKFx4FvTe9Ecc\nd/EecyXsPT1ATCKW6WUm1GO6HdNxQmb255lWTufw8DNuMSzpvBgvA0Ub3QCD\nNlqiLmLkpj+4OsaRe17KzbT0ssf96HkXMjV+SK810hFjFcLq27N3/m28i3Ro\nnSjNC7idPO7JTXidS7XIftnawTlF9+d5Ms+38fDQmX+1fe6U/DBazLRB+S51\nyuc4I55cq5AiqIskVVAEmXGfqgdvKU1Nsxw8Ot7bPpiS6NmH/Hs29FHevvzv\n7c3HuG+YpYOxGqQci4rjgm1/qjPhLzzR3bIyLo45yu+GCY4OqVEzl5bdSoIG\nRHCiypNjq4vuK0LaPCrzv5pHGh6bao34SmSxlYg5F/dN7Fexh6bloeXD5oF+\n8aLE\r\n=xkyF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHhfzvgSm91kz/2ePXrnsR0991+N82ccVW7NPR3idxl2AiEAoqfbMe+HHYE2oWuIus471uMVCEQ5/oGc8YCAHBKZ9VI="}]},"_npmUser":{"name":"dale.sande","email":"dale.sande@alaskaair.com"},"directories":{},"maintainers":[{"name":"blackfalcon","email":"dale.sande@gmail.com"},{"name":"dale.sande","email":"dale.sande@alaskaair.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aurolabs-background_1.0.0_1622591102576_0.6684260013435006"},"_hasShrinkwrap":false}},"time":{"created":"2021-06-01T23:45:02.226Z","1.0.0":"2021-06-01T23:45:02.783Z","modified":"2023-08-01T16:33:37.308Z"},"maintainers":[{"email":"dale.sande@alaskaair.com","name":"dale.sande"},{"email":"dale.sande@gmail.com","name":"blackfalcon"}],"description":"aurolabs-background HTML custom element","homepage":"https://github.com/AlaskaAirlines/aurolabs-background#readme","keywords":["alaska airlines","auro","design system","web components"],"repository":{"type":"git","url":"git+https://github.com/AlaskaAirlines/aurolabs-background.git"},"bugs":{"url":"https://github.com/AlaskaAirlines/aurolabs-background/issues"},"license":"Apache-2.0","readme":"# Background\n\n`<auro-background>` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of ...\n\n## UI development browser support\n\nFor the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)\n\n## Install\n\n[![Build Status](https://img.shields.io/github/workflow/status/AlaskaAirlines/auro-background/Test%20and%20publish?branch=master&style=for-the-badge)](https://github.com/AlaskaAirlines/auro-background/actions?query=workflow%3A%22test+and+publish%22)\n[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-background?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-background)\n[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-background?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)\n\n```shell\n$ npm i @aurodesignsystem/auro-background\n```\n\nInstalling as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.\n\n### Design Token CSS Custom Property dependency\n\nThe use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).\n\n### CSS Custom Property fallbacks\n\n[CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) are [not supported](https://auro.alaskaair.com/support/custom-properties) in older browsers. For this, fallback properties are pre-generated and included with the npm.\n\nAny update to the Auro Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties.\n\n### Define dependency in project component\n\nDefining the component dependency within each component that is using the `<auro-background>` component.\n\n```javascript\nimport \"@aurodesignsystem/auro-background\";\n```\n\n**Reference component in HTML**\n\n```html\n<auro-background>Hello World</auro-background>\n```\n\n## Install bundled assets from CDN\n\nIn cases where the project is not able to process JS assets, there are pre-processed assets available for use. Two bundles are available -- `auro-background__bundled.js` for modern browsers and `auro-background__bundled.es5.js` for legacy browsers (including IE11).\n\nSince the legacy bundle includes many polyfills that are not needed by modern browsers, we recommend you load these bundles using [differential serving](https://philipwalton.com/articles/deploying-es2015-code-in-production-today/) so that the browser only loads the bundle it needs. To accomplish this, the script tag for the modern bundle should have `type=\"module\"` and the script tag for the legacy bundle should have the `nomodule` attribute. See the example below.\n\n### Bundle example code\n\n**NOTE:** Be sure to replace `@latest` in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk.\n\n```html\n<link rel=\"stylesheet\" href=\"https://unpkg.com/@alaskaairux/design-tokens@latest/dist/tokens/CSSCustomProperties.css\" />\n<link rel=\"stylesheet\" href=\"https://unpkg.com/@alaskaairux/webcorestylesheets@latest/dist/bundled/essentials.css\" />\n\n<script src=\"https://unpkg.com/@alaskaairux/auro-background@latest/dist/auro-background__bundled.js\" type=\"module\"></script>\n<script src=\"https://unpkg.com/@alaskaairux/auro-background@latest/dist/auro-background__bundled.es5.js\" nomodule></script>\n```\n\n## auro-background use cases\n\nThe `<auro-background>` element should be used in situations where users may:\n\n* ...\n* ...\n* ...\n\n## API Code Examples\n\nDefault auro-background\n\n```html\n<auro-background>Hello World</auro-background>\n```\n\n## Development\n\nIn order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.\n\nPlease be sure to review the [contribution guidelines](https://auro.alaskaair.com/getting-started/developers/contributing) for this project. Please make sure to **pay special attention** to the **conventional commits** section of the document.\n\n### Start development environment\n\nOnce the project has been cloned to your local resource and you have installed all the dependencies you will need to open two different shell sessions. One is for the **npm tasks**, the second is to run the **server**.\n\n```shell\n// shell terminal one\n$ npm run dev\n\n// shell terminal two\n$ npm run serve\n```\n\nOpen [localhost:8000](http://localhost:8000/)\n\n### Testing\nAutomated tests are required for every Auro component. See `.\\test\\auro-background.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.\n\n### Demo deployment\n\nTo deploy a demo version of the component for review, run `npm run demo:build` to create a `./build` directory that can be pushed to any static server.\n\n<small>Built from WC-Generator v3.1.1</small>\n","readmeFilename":"README.md"}