@girder/components

Girder web component library

Try the demo app. It works with data.kitware.com.

Usage Quickstart

This library only supports Vue 2.

Installation

Vue CLI is required for building applications with Girder web components. You will also need to install Vue CLI Plugin Vuetify.

First, install Vuetify if you aren't already using it.

vue add vuetify

For new projects, the default preset is good. For established projects, choose advanced and reject pre-made templates for a less invasive install. All other options are up to you.

Note the cli plugin install may modify package.json, vue.config.js, index.html, and several others. Mostly, it just reorders your existing configuration, but be sure to review the changes carefully.

# Install GWC
yarn add @girder/components
# or
npm install @girder/components

# Install additional dev dependencies
yarn add -D sass sass-loader@^7.3.1

Note: If you are building with custom webpack (without vue-cli-service), you should follow Vuetify's Webpack install instructions

Initialization

Encapsulating the configuration in another file (typically src/plugins/girder.js) is a good practice.

/* src/plugins/girder.js */
import Vue from 'vue';
import Girder, { RestClient } from '@girder/components/src';

// Install the Vue plugin that lets us use the components
Vue.use(Girder);

// This connects to another server if the VUE_APP_API_ROOT
// environment variable is set at build-time
const apiRoot = process.env.VUE_APP_API_ROOT || 'http://localhost:8080/api/v1';

// Create the axios-based client to be used for all API requests
const girderRest = new RestClient({
  apiRoot,
});

// This is passed to our Vue instance; it will be available in all components
const GirderProvider = {
  girderRest,
};
export default GirderProvider;

Reference the configuration from your application initialization (typically src/main.js):

/* src/main.js */
import GirderProvider from '@/plugins/girder';
import { vuetify } from '@girder/components/src';

// ...

new Vue({
  provide: GirderProvider,
  // Import and use vuetify config from girder/components without modification
  // See below for how to inject your own config
  vuetify,
  // ...
}).$mount('#app');

Using Components

All components are prefixed Girder.

A-la-carte (recommended)

To use components individually, they should be imported by name from @girder/components/src, as this location will be stable across releases. For instance:

import { GirderUpload } from '@girder/components/src'; // Good
import { Upload } from '@girder/components/src/components/Upload.vue'; // Unsafe -- may move in the future

Since Girder web components uses Vuetify, your application must provide v-app and v-content containers at some ancestor level.

For example, to create a login / registration widget in src/App.vue:

<!-- src/App.vue -->
<template>
  <v-app>
    <v-content>
      <h1>Welcome {{ currentUserLogin }}</h1>
      <GirderAuthentication register />
    </v-content>
  </v-app>
</template>

<script>
import { GirderAuthentication } from '@girder/components/src';

export default {
  components: {
    GirderAuthentication,
  },

  // Injecting is not necessary to use the component,
  // but is required to access the results of API calls
  inject: ['girderRest'],
  computed: {
    currentUserLogin() {
      return this.girderRest.user ? this.girderRest.user.login : 'anonymous';
    },
  },
};
</script>

Global registration

You can register all components with the global scope and avoid individual imports.

See documentation for a list of component names.

import GirderProvider from '@/plugins/girder'; // same as above
import { vuetify, registerComponents } from '@girder/components/src';

// register all components globally, named `girder-{name}`
registerComponents();

new Vue({
  provide: GirderProvider,
  vuetify,
}).$mount('#app');

See the demo app for a more comprehensive example.

Advanced Usage

Customizing Vuetify Configuration

If your downstream application is also using Vuetify and needs to pass additional configuration options, it must be careful to coordinate with Girder web components.

Additional Vuetify configuration should inherit from Girder web components' own configuration:

import { merge } from 'lodash';
import { vuetifyConfig as girderVuetifyConfig } from '@girder/components/src';

const appVuetifyConfig = merge(girderVuetifyConfig, {
  icons: {
    values: {
      myCustomIcon: 'mdi-custom-icon'
    }
  }
});

Note: You must use the mdi icon pack. Icon packs cannot be mixed.

import Vuetify from 'vuetify/lib';
import GirderProvider from '@/plugins/girder'; // same as above

new Vue({
  provide: GirderProvider,
  vuetify: new Vuetify(appVuetifyConfig),
}).$mount('#app');

Note: Girder web components imports a-la-carte vuetify/lib, so you should do the same to avoid building duplicate dependencies into your artifacts.

Other installation methods

It's not necessary to install Girder web components yourself, you can import the pre-built bundle into your page by including the following tags:

<script src="https://unpkg.com/vue/dist/vue.min.js"></script>
<script src="https://unpkg.com/@girder/components"></script>
<link rel="stylesheet" href="https://unpkg.com/@girder/components/dist/girder.css">

This will expose all the library's components and utilities under the global variable girder, e.g. girder.RestClient and girder.GirderUpload.

Note: If importing this library's UMD bundle via a <script> tag, the incantation for installing the Vue plugin is slightly different:

Vue.use(girder.default);

For developers

# Project Setup
yarn

# Compile and hot-reload for development
yarn serve

# Build the library for production
yarn build

# Lint and fix source code
yarn lint
yarn lint:style

# Run unit tests
yarn test:unit

Note: sideEffects config for tree shaking is informed by this issue

Use an external Girder API

To build the demo app against an external Girder API, set the VUE_APP_API_ROOT environment variable. For example:

export VUE_APP_API_ROOT=https://data.kitware.com/api/v1
yarn serve

This variable value defaults to http://localhost:8080/api/v1 for normal development (which assumes the developer has a local instance of the Girder API server running). When running against your own instance of the Girder API server, make sure to set CORS accordingly.

Displaying private media from Girder on a page

If your app injects media dynamically into the page using img or video elements that load from Girder, there are several requirements.

• You must use the authenticateWithCredentials option in the GirderRest constructor.
• You must modify Girder's CORS allowed origin settings to match your app's origin exactly. You can use a comma-separated list to match multiple origins, for example *, http://localhost:8080, https://myapp.domain.com
• To interact with the loaded element data from a canvas or JS, you may need to add the crossOrigin attribute to the media element.

Deploy and Publish

The demo app is automatically deployed to gwc.girder.org.

Any contributor can request an update to the published npmjs version by changing the version string in package.json and opening a pull request. Our CI runner will detect the change and publish on merge. Version update PRs should generally happen independently of feature PRs.

Type Definitions

TypeScript type defs are maintained at index.d.ts. Please remember to update this file if your change impacts the public api.