Newsworthy Presidential Mistakes

    @deckdeckgo/remote
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.0 • Public • Published

    npm license

    DeckDeckGo - Remote

    This project is a Web Component which act as the remote control receiver of the Progressive Web App of DeckDeckGo .

    Table of contents

    Features

    Once added in your project it will add the two following two main features:

    1. It create a real-time communication channel using WebRTC with the Progressive Web App of DeckDeckGo
    2. It add a canvas over the content which will reflect what will be drawn in the Progressive Web App

    Getting Started

    Start you new presentation by following the quick 👉 Getting Started guide 👈

    Standalone

    To create easily your PWA presentation and to enjoy all the options, I suggest you to use the starter kit as described in the documentation.

    However, if you wish to use this Web Component as a standalone component to add a remote control to your DeckDeckGo's presentation you would have installed as standalone too, install it as the following:

    Install from NPM

    Install it in your project from npm using the following command:

    npm install deckdeckgo-remote

    Using from a CDN

    It's recommended to use unpkg to use this component from a CDN. To do so, add the following include script in the main HTML file of your project:

    <script src="https://unpkg.com/deckdeckgo-remote@latest/dist/deckdeckgo-remote.js"></script>
    

    Framework integration

    The Stencil documentation provide examples of framework integration for Angular, React, Vue and Ember.

    Usage

    This Web Component could be integrated and used like the following:

    <deckgo-remote room="my_presentation" width="300" height="200" slides="5"></deckgo-remote>
    

    For a more concrete example you could have a look to the DeckDeckGo Starter-kit

    Attributes

    The following options should be set using attributes:

    Attribute Type Description
    room string The room respectively the presentation's name which will be displayed to the user in the app when he/she will search for presentations to connect to
    socketUrl string A socket URI, in case you would implement your own signaling server
    width number The width of the canvas
    height number The height of the canvas
    length number How many slides contains your deck, this is useful to inform the app about it and initialize the length of the canvas
    slides string[] The ordered list of all the tag names of the slides. Useful if you would like to inform the app about which slides are used in your deck.
    autoConnect boolean If you the component to not connect itself on load, set this property to false

    Methods

    Furthermore to attributes, this Web Component exposes methods too.

    Note: For description purpose, we reference a remote object we would have been initialized like the following in Vanilla Javascript:

    const remote = document.getElementsByTagName('deckgo-remote');
    

    Connect

    Connect will open a socket with the signaling server and create a room for the presentation. If an application would wait for such a room, it will also inform this application that the receiver is yet available in order to establish the WebRTC connection.

    await remote.connect();
    

    Disconnect

    Disconnect will close the socket with the signaling server and remove the deck from the list of possible deck to connect to.

    await remote.disconnect();
    

    Move canvas

    You might need to move the canvas, this method let's you move it.

    await remote.moveDraw(leftOffset, transitionDuration);
    

    Next slide

    If you would slide in your presentation, you could call this method in order to send the information to the application, in order to reflect the slide change in the application too.

    await remote.nextSlide();
    

    Prev slide

    If you would slide in your presentation, you could call this method in order to send the information to the application, in order to reflect the slide change in the application too.

    await remote.prevSlide();
    

    Go to a specific slide

    This method will emit an event from the deck to slide to a specific slide.

    await remote.slideTo(0); // parameters: index: number, speed?: number | undefined
    

    Update slides

    This method will emit an event from the deck to the remote in order to update the list of slides.

    await remote.updateSlides();
    

    Delete slide

    This method will delete the current slide in the remote app.

    await remote.deleteSlide();
    

    Update slide

    This method will emit an event to update a particular slide in the remote.

    await remote.updateSlides(index, slideDefinition);
    

    Update reveal

    This method will emit an event to update the reveal settings of the deck of the remote.

    await remote.updateReveal(reveal);
    

    Play

    This method will tell the remote app that the play action was performed in the deck.

    await remote.play();
    

    Pause

    This method will tell the remote app that the pause action was performed in the deck.

    await remote.pause();
    

    License

    MIT © David Dal Busco and Nicolas Mattia

    Install

    npm i @deckdeckgo/remote

    DownloadsWeekly Downloads

    97

    Version

    2.2.0

    License

    MIT

    Unpacked Size

    891 kB

    Total Files

    46

    Last publish

    Collaborators

    • peterpeterparker