@mklog/widgets
TypeScript icon, indicating that this package has built-in type declarations

0.5.1 • Public • Published

Makelog Widgets

mklog-ledger

The Changelog component is used for displaying an organizations ledger in a web page. The component can be used as standard HTML element by following this example:

<mklog-ledger
  organization="d6f520d3-d197-4090-a9b2-9259b5828755"
  kind="element">
</mklog-ledger>

Or as popup that is triggered when the wrapped HTML element is clicked. As in this example:

<mklog-ledger
  organization="d6f520d3-d197-4090-a9b2-9259b5828755"
  kind="popper">
  <a class="menu-item" href="javascript:void">Changelog</a>
</mklog-ledger>

Basic styling is allowed for the ledger component using CSS variables. As an example:

  mklog-ledger {
    --mklog-color-brand-background: #121927;
    --mklog-color-brand-text: #E5E7EB;
  }

Properties

Property Attribute Description Type Default
heading heading string 'Product Updates'
kind kind Determines how the ledger is rendered either as a standard HTML element (default) or as a pop-up triggered when any contained HTML is clicked. "element" | "popper" 'element'
organization (required) organization string undefined
subheading subheading string 'The latest features, improvements, and bug fixes.'

Readme

Keywords

none

Package Sidebar

Install

npm i @mklog/widgets

Weekly Downloads

6

Version

0.5.1

License

none

Unpacked Size

18.4 MB

Total Files

260

Last publish

Collaborators

  • hubbs_
  • kyle-makelog