callout-alert
v1.0.1
Published
Markdown Callouts, as a Web Component, written in Tram-Lite
Downloads
7
Maintainers
Readme
callout-alert
A Github / Obsidian inspired web component for displaying a callout in your page.
How to use
<script src="https://unpkg.com/callout-alert@1"></script>
<callout-alert type="tip">
Optional information to help a user be more successful.
</callout-alert>
Types of Alerts
The following types are available by default:
| type | color | icon | title |
| ----------- | ------ | ---------------- | --------- |
| note
| blue | info circle | Note |
| tip
| green | lightbulb | Tip |
| important
| purple | report comment | Important |
| warning
| yellow | warning triangle | Warning |
| caution
| red | report octogon | Caution |
| Default | grey | document icon | Note |
You can also configure the Color, Icon, and Title using CSS variables or slots.
CSS API
The following CSS variables can be used to control the presentation of the component:
You can set some or all of these for a specific callout-alert
instance, or at
a page level.
<style>
callout-alert {
--callout-color: 0, 200, 225;
--callout-icon: 'bolt';
--callout-title: 'Alert';
}
</style>
<callout-alert> Watch out for Lightning bolts! </callout-alert>
Slot API
You can use the following slot names to change the icon or title of the callout.
You can set some or all of these inside a callout-alert
instance.
<callout-alert type="tip">
<span slot="icon">📦</span>
<span slot="title">Slots</span>
This is a custom alert, that uses slots to set the icon and title.
</callout-alert>
Known Limitations
Below are a list of known limitations. While there may be available solutions here, an effort has been made to make the code as straight-forward as possible.
Colors
Until relative CSS colors are universally supported, the colors are defined as three numbers. Ideally, once relative colors are supported, we would allow any CSS color (this will be marked as a breaking change, if introduced).
Icon Library
By default, this component loads Google's Material Icon font in the owner document using javascript. Sadly, it's currently not possible to load font-families from a web component context, or from a stylesheet in a component.
Development
This component was built using Tram-Lite, you can read more about the project at https://tram-one.io/tram-lite/.
You can load all the component variants, plus a slot and CSS variable example by running:
npm ci
npm run build
npm start
Then, navigate to the listed IP address /example
.