README.md

Phoenix Tooltip

Tooltip Komponente. Ähnlich zum HTML title-Tag.

Die Komponente ist Teil des Phoenix Reisen Design-Systems.

Demo

https://phoenixreisen.github.io/mithrils/tooltip

Installation

Mithril wird benötigt.

npm install --save @phoenixreisen/mithrils

Anwendung

import Tooltip from '@phoenixreisen/mithrils/tooltip';

// API

export interface Attrs {
    event?: 'hover' | 'click',
    type?: 'component' | 'text',
    position?: 'above' | 'right' | 'below' | 'left',
    TipComponent: m.Component,
    TextComponent: m.Component,
}

// Aufruf

<Tooltip 
    event="click"
    position="right"
    type='component'
    TipComponent={
        <Content />
    }
    TextComponent={
        <i className="fas fa-info-circle c-warning"></i>
    }
/>

Demo für Github Page

Mit folgendem Befehl werden alle Demos in den Ordner ../../docs gebaut. Dieser Ordner wird von Github zur Bereitstellung der Demos bzw. Github Pages genutzt.

Möchte man zum Entwickeln nur bestimmte Demos bauen, kann man in der rollup.config.js nicht benötigte Demos auskommentieren, sollte sie vor dem push aber wieder einkommentieren.

npm run compile:demos

Test

[npm install]
npm run test

Deployment

Deployed & published wird immer die ganze Sammlung. Siehe hier.