Code Monkey home page Code Monkey logo

seatsio-vue's Introduction

seatsio-vue, the official Seats.io Vue wrapper

Vue wrapper for rendering Seats.io seating charts. Brought to you by the Seats.io team.

Installation

Npm
npm install --save @seatsio/seatsio-vue

Yarn
yarn add -dev @seatsio/seatsio-vue

Usage

Regular charts

Minimal example to render a seating chart:

import { SeatsioSeatingChart } from '@seatsio/seatsio-vue';

<div style="height: 500px">
    <SeatsioSeatingChart
        workspaceKey="<yourPublicWorkspaceKey>"
        event="<yourEventKey>"
        region="eu"
    />
</div>

The chart uses 100 % of the width and height of the DOM element (e.g. a div) in which you render it. Play with the size of that element to change the chart size.

Reacting to events

onRenderStarted()

onRenderStarted is fired when the chart has started loading, but hasn't rendered yet. If you store the chart object that's passed to the onRenderStarted callback, you can access the properties defined on the wrapped seatsio.SeatingChart:

// Single File Component (SFC) using SeatsioSeatingChart
export default {
    ...
    data() {
        return {
            chart: null
        }
    },
    methods: {
        onRenderStarted: function (chart) {
            this.chart = chart
            console.log(chart.selectedObjects)
        } 
    }
}

<SeatsioSeatingChart
    workspaceKey="<yourPublicWorkspaceKey>"
    event="<yourEventKey>"
    // Notice how the event handler is defined with @<eventListener>
    // For more information, see https://vuejs.org/guide/essentials/event-handling.html
    @onRenderStarted="onRenderStarted"
    region="eu"
/>

onChartRendered()

onChartRendered is fired when the chart is rendered successfully:

export default {
    ...
    data() {
        return {
            chart: null
        }
    },
    methods: {
        onChartRendered: function (chart) {
            this.chart = chart
            console.log(chart.selectedObjects)
        } 
    }
}

<SeatsioSeatingChart
    workspaceKey="<yourPublicWorkspaceKey>"
    event="<yourEventKey>"
    @onChartRendered="onChartRendered"
    region="eu"
/>

Supported properties

Other parameters are supported as well. For a full list, check https://docs.seats.io/docs/renderer/embed-a-floor-plan

Example: Passing in a custom object color:

export default {
    ...
    data() {
        // Supports CSS color values
        objectColor: () => 'grey',
    },
}

<SeatsioSeatingChart
    workspaceKey="<yourPublicWorkspaceKey>"
    event="<yourEventKey>"
    region="eu"
    :objectColor="objectColor"
/>

Whenever one of the properties passed on to <SeatsioSeatingChart /> changes, the chart destroys itself and rerenders. To avoid such a 'full refresh', you can use chart.changeConfig() instead of updating the properties directly. Please check https://docs.seats.io/docs/renderer-chart-properties-chartchangeconfig. Note that changeConfig() only supports a subset of all available chart parameters.

Event manager

import { SeatsioEventManager } from '@seatsio/seatsio-vue';

<div style="height: 500px">
    <SeatsioEventManager
        secretKey="<yourWorkspaceSecretKey>"
        event="<yourEventKey>"
        mode="<manageObjectStatuses or another mode>"
        region="eu"
    />
</div>

Other parameters are supported as well. For a full list, check https://docs.seats.io/docs/event-manager/configuring

Chart manager

import { SeatsioChartManager } from '@seatsio/seatsio-vue';

<div style="height: 500px">
    <SeatsioChartManager
        secretKey="<yourWorkspaceSecretKey>"
        chart="<yourChartKey>"
        mode="<manageRulesets or another mode>"
        region="eu"
    />
</div>

Other parameters are supported as well. For a full list, check https://docs.seats.io/docs/chart-manager/configuring/

Seating Chart Designer

To embed the seating chart designer for the purpose of creating a new chart, do this:

import { SeatsioDesigner } from '@seatsio/seatsio-vue';

<div style="height: 500px">
    <SeatsioDesigner
        secretKey="<yourWorkspaceSecretKey>"
        region="eu"
    />
</div>

To be able to edit a chart from an embedded designer, you need to specify the chart to load:

<SeatsioDesigner
    secretKey="<yourWorkspaceSecretKey>"    
    chartKey="<yourChartKey>"
    region="eu"
/>

Other parameters are supported as well. For a full list, check https://docs.seats.io/docs/embedded-designer/introduction

seatsio-vue's People

Contributors

bverbeken avatar mortendevold avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.