1.0.5 • Published 4 years ago

nist-embeddable-components v1.0.5

Weekly downloads
-
License
MIT
Repository
-
Last release
4 years ago

Built With Stencil

How to use on a page

Script tag (Landing pages, Nist Wissen)

  • Insert both script tags in the head of your index.html file: <script type="module" src='https://unpkg.com/nist-embeddable-components/dist/embeddable-components/embeddable-components.esm.js'></script> <script nomodule src='https://unpkg.com/nist-embeddable-components/dist/embeddable-components/embeddable-components.js'></script>

Node Modules

  • Run npm i nist-embeddable-components --save
  • Put a script tag <script src='node_modules/nist-embeddable-components/dist/embeddable-components.js'></script> in the head of your index.html

Components

Additional Cost Calculator

You can use: <additional-cost-calculator></additional-cost-calculator> anywhere in your template, JSX, html etc. Keep in mind the hyphen notation.

Rent Slider

You can use: <rent-slider></rent-slider> anywhere in your template, JSX, html etc. Keep in mind the hyphen notation.

Customisation

Following attributes can be altered:

  • heading - header text displayed directly above slider. Default value: Wie viel Miete zahlst Du im Monat?

  • first-content-line - Rent slider text - first line. Default value: Du kannst Dir eine Immobilie für

  • second-content-line - Rent slider text - second line. Default value: leisten

  • max-rent - Maximum possible value of monthly rent. Default value: 3500

  • min-rent - Minimum possible value of monthly rent. Default value: 300

  • rent-step - A step value for rent range control. Default value: 100

  • cta-text - CTA text. Default value: Jetzt Finanzierung anfragen

  • cta-url- Location where the CTA should lead after click. Default value: https://www.nist.de/angebote-kontakt

  • cta-show - A value that indicates whether the CTA should be displayed or not. Default value: true

  • cta-new-tab - A value that indicates whether the CTA should open in a new tab or not. Default value: false

  • forward-url-params - A value that indicates whether the CTA should append the query params from the parent page. Default value: false

Customisation example: <rent-slider cta-show="false" min-rent="100" max-rent="100000" forward-url-params="true"></rent-slider>

Loan Slider

You can use <loan-slider></loan-slider> anywhere in your template, JSX, html etc. Keep in mind the hyphen notation.

Customisation

Following attributes can be altered:

  • header-shown Default value: true

  • footerControlsShown Default value: true

  • heading-text Default value: "Wie viel Hauskredit benötigst Du?"

  • sub-heading-text Default value: "Gib hier Kaufpreis & Eigenkapital an."

  • cta-text Default value: "Jetzt Budget berechnen"

  • cta-url Default value: "https://www.nist.de/angebote-kontakt"

Customisation example: <loan-slider header-shown="false" heading-text="is a heading text" sub-heading-text="is a sub heading text" cta-text="is a cta text"></loan-slider>

Developer Notes

How work with / edit / extend etc... (for developers)

This is a starter project for building a standalone Web Component using Stencil.

To run the component locally clone and:

npm install
npm start

To build the component for production, run:

npm run build

To publish the component for production, run:

npm login

One must log in with thier npmjs account credentials. Afterwards, run:

npm publish

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

5 years ago

1.0.0

5 years ago