Permalink
7df144a Aug 9, 2018
2 contributors

Users who have contributed to this file

@lukyanovas @IlyaKhD
363 lines (287 sloc) 11.5 KB

DevExtreme Vue UI and Visualization Components

Build Status Project Status NPM

This project allows you to use DevExtreme Widgets as Vue Components.

Getting Started

You can try this live example (no need to install anything).

See the sections below if you prefer using a local development environment.

Prerequisites

Node.js and npm are required

Install DevExtreme

Install the devextreme and devextreme-vue npm packages:

npm install --save devextreme@18.1 devextreme-vue

Additional Configuration

The further configuration steps depend on which build tool, bundler or module loader you are using. Please choose the one you need:

Import DevExtreme Modules and Themes

Import DevExtreme modules in a DevExtreme component's file.

import { DxButton } from 'devextreme-vue';

DevExtreme themes can be imported only once in your application's main file:

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.compact.css';

See the Predefined Themes guide for more information on DevExtreme themes.

Use DevExtreme Components

You can use DevExtreme components in a single file component...

<template>
    <dx-button :text='text'/>
</template>

<script>
import { DxButton } from 'devextreme-vue';
export default {
  name: 'HelloWorld',
  data() {
    return {
      text: 'Hello!'
    };
  },
  components: {
    DxButton
  }
};
</script>

... in a jsx render function

import Vue from 'vue';
import { DxButton } from 'devextreme-vue';


new Vue({
  el: '#app',
  data: function() {
    return {
      text: "Hello!"
    }
  },
  render: function(h) {
    return (
      <DxButton text={this.text} />
    )
  }
});

... or directly in a vue template

new Vue({
  el: '#app',
  components: { DxButton },
  template: '<dx-button :text="text" />',
  data() {
    return {
      text: 'Hello!'
    };
  }
});

API Reference

DevExtreme Vue components are similar to the DevExtreme JavaScript API but use Vue syntax for specifying widget options, subscribing to events and custom template declaration.

Component Configuration

Set Component Option

  • A constant string value (for example, the Button text):
<dx-button text="Simple button" />
  • A constant non-string value (for example, the CheckBox value):
<dx-check-box :value="true" />
  • A value from a component data:
<dx-button :text="text" />

where : is a shorthand for v-bind directive.

Two-way Binding

Use the sync modifier to bind a bindingProperty to a widget option:

<dx-text-box :value.sync="bindingProperty" />

Editors Value Binding

The DevExtreme Vue editors also support v-model directive that creates two-way binding on the editor's value (for example, TextBox value):

<dx-text-box v-model="text" />

Custom Templates

You can customize widget elements' appearance via the corresponding template properties.

To specify a DevExtreme Vue Component template, use a named slot to specify a template's markup. You also should specify a slot scope to access the template element's data.

For instance, you can specify the itemTemplate:

<div id="app">
    <dx-list :items="items">
        <div slot="item" slot-scope="data">
            <i>This is my template for {{data}}</i>
        </div>
    </dx-list>
</div>
import Vue from 'vue';
import { DxList } from 'devextreme-vue';

new Vue({
  el: '#app',
  components: { DxList },
  data() {
    return {
      items: [1, 2, 3, 4]
    };
  }
});

item is the default template name of the dxList widget's itemTemplate option. You can specify a custom name for the itemTemplate option and for your slot:

<div id="app">
    <dx-list :items="items" item-template="my-template">
        <div slot="my-template" slot-scope="data">
            <i>This is my template for {{data}}</i>
        </div>
    </dx-list>
</div>

Components with Transcluded Content

In addition to using templates, you can put the following widgets' content directly into the markup: Resizable, ScrollView, ValidationGroup. For instance, you can specify the ScrollView widget's content as follows:

<dx-scroll-view>
    <div>Some scrollable content</div>
</dx-scroll-view>

Event Handling

You can subscribe to DevExtreme Component Events using the Vue's v-on directive (or @ shorthand)

<dx-text-box v-model="text" @focusIn="handleFocusIn'" />
data: function() {
  return {
    text: "text",
    handleFocusIn: () => {
      this.text = 'focused!';
    }
  };
}

You can find the full list of component events in each DevExtreme widget API Reference's Events section (for example, TextBox events).

Getting a Widget Instance

A widget instance is used when calling a widget method. You can get it in the following way:

  1. Assign a unique key to the component's ref attribute.
  2. Use this key to retrieve the component from the $refs property.
  3. Use the component's instance property to get the widget instance.
<template>
    <div title="Accessing Widget Instance">
        <dx-text-box :ref="textBoxRefName"/>
        <br/>
        <dx-button text="Set focus" @click="setFocus"/>
    </div>
</template>

<script>
import { DxButton, DxTextBox } from "devextreme-vue";

const textBoxRefName = "some-ref-name";

export default {
  data: function() {
    return {
      textBoxRefName
    };
  },

  components: {
    DxTextBox,
    DxButton
  },

  methods: {
    setFocus: function() {
      this.textBox.focus();
    }
  },

  computed: {
    textBox: function() {
      return this.$refs[textBoxRefName].instance;
    }
  }
};
</script>

Type Checks

You should specify proper values for the components' properties because DevExtreme Vue components use Prop Validation and Type Checks. Otherwise, Vue produces a console warning (if you are using the development build).

DevExtreme Data Layer and Utils

The DevExtreme includes a Data Layer and Utils that can be helpful in different scenarios.

DevExtreme Validation

DevExtreme Vue editors support built-in data validation.

<dx-validation-group>
  <dx-text-box value="email@mail.com">
    <dx-validator :validationRules="validationRules.email" />
  </dx-text-box>
  <dx-text-box value="password">
    <dx-validator :validationRules="validationRules.password" />
  </dx-text-box>
  <dx-validation-summary />
  <dx-button text="Submit" @click="validate"/>
</dx-validation-group>
import { DxButton, DxTextBox, DxValidator, DxValidationGroup, DxValidationSummary } from "devextreme-vue";

export default {
  components: {
    DxButton,
    DxTextBox, 
    DxValidator,
    DxValidationGroup,
    DxValidationSummary
  },
  methods: {
    validate(params) {
      const result = params.validationGroup.validate();
      if (result.isValid) {
          // form data is valid
          //params.validationGroup.reset();
      }     
    }
  },
  data: function() {
    return {
      validationRules: {
        email: [
            { type: "required", message: "Email is required." },
            { type: "email", message: "Email is invalid." }
        ],
        password: [
            { type: "required", message: "Password is required." }
        ]
    }};
  }
};

License

DevExtreme Vue components are released as an MIT-licensed (free and open-source) DevExtreme add-on.

See the DevExtreme License for more information.

A free trial is available

Support & Feedback