@postnord/pn-marketweb-components 4.0.0 → 4.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018
+
+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.

package/README.md

@@ -0,0 +1,74 @@
+# pn-marketweb-components
+
+This solution compiles web components using Stencil.js
+The goal of this package is to allow other projects to use components from the Market Websites and allow SPAs to look like they are a part of the market websites.
+
+## Installation
+
+This includes both the PN Web Components and the Market Web Components.
+
+```
+npm install --save-dev @postnord/web-components
+npm install --save-dev @postnord/pn-marketweb-components
+```
+
+## Recommended extensions
+
+### Accessibility
+For Vscode you will get a prompt of recommended extensions and there is a accessibility specific one called Axe Linter.
+
+Visual Studio have this linting rules build in.
+
+https://marketplace.visualstudio.com/items?itemName=deque-systems.vscode-axe-linter
+
+
+
+
+## Usage
+
+### Script
+
+To use these web components you need to automatically register them first.
+Add this to your main script
+
+```
+import { defineCustomElements } from '@postnord/web-components/loader';
+defineCustomElements(window, { resourcesUrl: '/Static/dist/' });
+
+import { defineCustomElements as defineCustomElementsMarketWeb} from '@postnord/pn-marketweb-components/esm-es5/loader';
+defineCustomElementsMarketWeb(window, { resourcesUrl: '/Static/dist/' });
+```
+
+Note that the "resourceUrl" should point to where the main script / assets are located.
+
+### Markup for integating market web header and footer
+
+#### Market Web Site header
+
+```
+<pn-marketweb-siteheader
+  market="se"
+  language="sv"
+  endpoint="https://com-inte.postnord.com">
+</pn-marketweb-siteheader>
+```
+
+#### Market Web Site footer
+
+```
+<pn-marketweb-sitefooter
+  market="se"
+  language="sv"
+  endpoint="https://com-inte.postnord.com">
+</pn-marketweb-sitefooter>
+```
+
+## How to package for testing in dev
+
+in package.json, change version number (ex. 1.0.50-test)  
+Run npm run build  
+Run npm run post:build  
+In dist directory, run npm pack  
+copy over the .tgz file to the javascript directory (where package.json exists)  
+Install the package with "npm install xxx.tgz"  
+Run your js build