Nimoy Prospers Mystically

    @myuw-web-components/myuw-help-link

    1.1.0 • Public • Published

    myuw-help-link

    This Web Component presents a stylized link to help.

    Using

    To use the myuw-help-link web component,

    1. Make it available in the HTML page by invoking suitable <script>, and
    2. Use it via the <myuw-help-link> element.

    Import the web component

    In MyUW

    MyUW provides a local CDN-like (Content Delivery Network-like) affordance.

    Rely upon the latest v1-compatible release

    <script
      type="module"
      src="/static/web-components/myuw/myuw-help-link/1-x/myuw-help-link.min.mjs"></script>
    <script
      nomodule
      src="/static/web-components/myuw/myuw-help-link/1-x/myuw-help-link.min.js"></script>

    (See documentation about myuw-help-link in static for more conservative options.)

    Using unpkg

    In HTML <head>,

    <script type="module" src="https://unpkg.com/@myuw-web-components/myuw-help-link@^1?module"></script>
    <script nomodule src="https://unpkg.com/@myuw-web-components/myuw-help-link@^1"></script>

    to import via unpkg.

    WARNING: unpkg is a third-party service neither provided nor endorsed by MyUW. In a MyUW context, sourcing from /static is preferred.

    Redistribute with the downstream app

    Alternatively include the web component files locally in the application and import from there.

    Invoke the Web Component

    Use the component's in the HTML page:

    <myuw-help-link
      app-context="Payroll"
      url="https://uwservice.wisc.edu/help/payroll">
    </myuw-help-link>

    app-context attribute

    The app-context attribute clarifies the scope and context of the help linked.

    Implementation detail: myuw-help-link uses it to compose the link label, as {app-context} resources and help. (This is an implementation detail, not a guarantee of the API exposed by myuw-help-link).

    url

    The url attribute tells the web component where the link should take the user.

    Absolute links (starting with http) open in a new tab (via target='_blank' with the page-jacking-prevention workaround of rel='noopener noreferrer').

    Developing

    Practice Semantic Versioning

    Carefully practicing Semantic Versioning allows downstream applications making use of myuw-help-link to automatically, transparently upgrade to the latest compatible version of the component.

    If a change is not backwards-compatible, it MUST yield a MAJOR version number bump, e.g. from 1.1.12 to 2.0.0.

    Keep a changelog

    Update CHANGELOG.md to document the changes. This is useful documentation, and it's also a prompt to think about the nature of the changes and to ensure that they are backwards-compatible.

    Locally testing

    npm install
    npm start

    Visit http://127.0.0.1:8080/docs/ .

    Releasing aka Publishing

    First, update package.json to reflect the version number you intend to release.

    Then

    npm publish --public

    and capture the /dist/ outputs to myuw-shared-static.

    Oh no that release wasn't backwards-compatible

    Immediately release a new PATCH version that restores compatibility.

    Keywords

    none

    Install

    npm i @myuw-web-components/myuw-help-link

    DownloadsWeekly Downloads

    1

    Version

    1.1.0

    License

    Apache-2.0

    Unpacked Size

    30.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • benjaminsousa
    • lstels
    • nogalpaulina
    • myuw-web-components-jenkins
    • jordanalanjones
    • zeke.witter
    • apetro
    • scott.berg