Lexik Doc

doc.md

Insertion :

<script>
    window.lxdoc = window.lxdoc || function () {(lxdoc.q = lxdoc.q || []).push(arguments)};
    lxdoc('project', 'demo');
</script>
<script async src='https://cdn.lexik.fr/widget.js'></script>

Ajout du contexte de la page :

<script>
    window.lxdoc = window.lxdoc || function () {(lxdoc.q = lxdoc.q || []).push(arguments)};
    lxdoc('project', 'demo');
    lxdoc('context', {
        route: 'demo_page_1'
    });
</script>
<script async src='https://cdn.lexik.fr/widget.js'></script>

Personnalisation :

<script>
    window.lxdoc = window.lxdoc || function () {(lxdoc.q = lxdoc.q || []).push(arguments)};
    lxdoc('project', 'demo');
    lxdoc('context', {
        route: 'demo_page_1'
    });
    lxdoc('config', {
        color: '#CA0048',
        theme: 'dark'
    });
</script>
<script async src='https://cdn.lexik.fr/widget.js'></script>

Utilisation de l'API JS asynchrone :

<script>
    window.lxdoc = window.lxdoc || function () {(lxdoc.q = lxdoc.q || []).push(arguments)};
    lxdoc('project', 'demo');
    lxdoc('context', {
        route: 'demo_page_1'
    });
    lxdoc('config', {
        color: '#CA0048',
        theme: 'dark'
    });
</script>
<script async src='https://cdn.lexik.fr/widget.js'></script>
<script>
    setTimeout(function () {
        lxdoc('open');
    }, 2500);
</script>

Propriétés (setters) :

• project string lxdoc('project', 'demo')
• context object lxdoc('context', {})
• path string lxdoc('path', '/demo') deprecated
• reference string lxdoc('reference', 'demo') deprecated

Méthodes:

• open() lxdoc('open')
• close() lxdoc('close')
• toggle() lxdoc('toggle')
• expand() lxdoc('expand')
• refresh() lxdoc('refresh')

Options :

• config
  • color: string
  • opacity: number
  • zIndex: number
  • theme: string
  • locale: string
  • eager: boolean default true
  • showBeacon: boolean default true
  • showSatellites: boolean default true
  • satellitesTriggerMode: string default 'click'
  • ready: function