Integrating Vault with React

You can use dhtmlxVault in an application created with the React framework. Check the demo on Github.

Please note that the implementation provided below is not the only way to use dhtmlxVault in a React-based application. It gives you initial schema of the integration and implies further extension of the app functionality depending on your goals.

Installation

The way of adding Vault sources into a React-based app makes a certain impact on its further reuse within the application. The most handy and least overburdening for an app variant is to install Vault through NPM.

If for some reason it doesn't suit you, you may choose between two more options: include Vault sources from a package, or make use of CDN.

Initialization

There are two possible scenarios of initializing Vault inside a React application. One consists in isolating Vault structure and data inside of the React component and another one suggests separating view and data parts with the possibility of interaction between them.

Scenario 1. Isolating Vault in a React component

In this variant Vault configuration and data are held inside of the React component with no bonds with the external part of the application.

Vault initialization

  • Create a Vault.js file, then create the Vault class and add a container for Vault using the render() function. Store the reference to the container in the el property:

Vault.js

class VaultComponent extends Component {
    render() {
        return (
        <div ref={el => this.el = el} className="widget-box"></div>
        );
    }
}
  • After that use the new Vault constructor to initialize Vault in the container created above:

Vault.js

class VaultComponent extends Component {
  componentDidMount() {
    this.vault = new Vault(this.el, {
      mode:"grid",
    });
  }
}

Loading data and changing config

  • Next you can load data into the Vault and change its configuration, e.g. add a new control into the toolbar:

Vault.js

class VaultComponent extends Component {
  componentDidMount() {
    this.vault = new Vault(this.el, {
      mode:"grid",
    });
    this.vault.data.parse([
      { name:"myfile_12.png", size: 32420 },
      { name:"myfile_13.png", size: 55674 },
      { name:"myfile_14.png", size: 12440 },
      { name:"info.doc", size: 243441 },
    ]);
 
    this.vault.toolbar.data.add({
      value:"MyAction"
    });
  }
  render() {
    return (
      <div ref={el => this.el = el} className="widget-box"></div>
    );
  }
}

Scenario 2. Exposing Vault data and config

This variant adds flexibility in the control over Vault data and configuration by allowing access to them from other parts of the application.

Vault initialization

  • The first step is the same. Create a file, let it be Vault2.js this time, and add the Vault class and use the new Vault constructor to initialize Vault.

Vault2.js

class VaultComponent extends Component {
  componentDidMount() {
    this.vault = new Vault(this.el, {
      // config here
    });
  }
}
  • Define the configuration properties of Vault in the object passed as a second parameter of the constructor:
class VaultComponent extends Component {
  componentDidMount() {
    this.vault = new Vault(this.el, {
      data: this.props.data,
      mode: this.props.mode,
      uploader:{
          autosend: this.props.autosend,
          target: this.props.target
      },
      toolbar: this.props.toolbar
    });
  }
}

Thus the props configuration option will be applied to the Vault widget configuration.

  • Then create a container for Vault using the render() function:

Vault2.js

render() {
    return (
      <div ref={el => this.el = el} className="widget-box"></div>
    );
}

Working with configuration options

Since the properties of Vault are exposed they are available to work with outside the component. In the example below the "grid" mode of rendering a list of files is enabled:

BasicSample.js

<div className='app-box'>
    <Vault toolbar mode="grid"></Vault>
</div>

Working with data

Work with data in this variant of using Vault in a React application can follow the MVVM pattern. Data collection represents Model and Vault represents View. Data collection and Vault are kept separately, and communicate with each other via particular links. Any changes made in the Model (Data collection) trigger corresponding changes in the View (Vault).

Usage of the MVVM pattern allows working with data outside Vault and all data-related manipulations can be moved to a separate file.

  • Create a DataSample.js file and create a new data collection named files in it:

DataSample.js

class VaultComponent extends Component {
  constructor(props) {
    super(props);
 
    this.files = new DataCollection();
  }
}
  • Bind the created data collection to Vault by referring to the collection in the data attribute:

DataSample.js

<Vault data={this.files} className='base-size'></Vault>

Due to data binding you can:

  • react to changes in the data

For example, by using the change event:

DataSample.js

class VaultComponent extends Component {
  constructor(props) {
    super(props);
 
    this.state = { count: 0 };
 
    this.files = new DataCollection();
    this.files.events.on("change", () => {
      this.setState({
        count: this.files.getLength()
      });
    });
  }
}
  • make changes in the data

For example, you can add files into the Vault and clear the list by clicking the bound buttons. In the example below buttons are subscribed to the onClick event:

DataSample.js

class VaultComponent extends Component {
  constructor(props) {
    super(props);
 
    this.files = new DataCollection();
  }
  render() {
    return (
      <div className='app-box'>
        <div className='line'>
          <input type="button" onClick={this.add} value="Add a file" />
          <input type="button" onClick={this.clear} value="Clear all" />
        </div>
      </div>
    );
  }
  add = () => { 
    this.files.add({ name:"myfile.png", size:24560 });
  }
  clear = () => {
    this.files.removeAll()
  }
}

A click on the "Add a file" button adds a file into the Vault and a click on the "Clear all" button cleans the list of files, as it's defined by the related methods.

Back to top