@synergy-design-system/vue

This package provides vue.js wrappers for Synergy Web Components.

It aims to provide an improved developer experience in Vue applications:

• Provides two way data binding and v-model
• Autocompletion and Types
• Better custom event handling of synergy events

Known issues and limitations

Got any problems using our Vue wrappers? Please take a look at our list of known issues and limitations before creating a ticket.

Getting started

1. Usage example

If you want to see a usage example, please check out our test Vue repository.

2. Package installation

Run the following steps to install the required packages.

1# Install the base library and required css files
2npm install --save @synergy-design-system/vue @synergy-design-system/tokens
3
4# Optional: Install the styles utility package
5npm install --save @synergy-design-system/styles
6
7# Optional: if icons shall be used, install the assets package
8npm install --save @synergy-design-system/assets

⚠️ Note we do not ship Vue in this package. You will have to install it by yourself first!

3. Load the desired theme (required) and utility classes (recommended)

The components will not display correctly without the needed theme and utility classes. Please include either light or dark theme in your application, for example in a newly installed Vue application:

1// src/main.ts
2// Add this line to enable the light theme for your application
3import "@synergy-design-system/tokens/themes/light.css";
4import "@synergy-design-system/components/index.css";
5
6// Optional: Import the styles package
7import "@synergy-design-system/styles/index.css";
8
9import { createApp } from "vue";
10import App from "./App.vue";
11
12createApp(App).mount("#app");

4. Importing and rendering components

You may now use the components by importing them from the @synergy-design-system/vue package and rendering them in your own Vue components.

1<script setup lang="ts">
2  // Note the name includes Vue here.
3  // This is done because it would
4  // clash with our native components otherwise
5  import { SynVueButton } from "@synergy-design-system/vue";
6</script>
7
8<template>
9  <SynVueButton type="submit"> Submit me </SynVueButton>
10</template>

5. Usage of the components

All information about which components exist as well as the available properties, events and usage of a component, can be found at components in our documentation. The documentation is written for no specific web framework but only vanilla html and javascript.

An example demo repository with the usage of the Vue wrapper components can be found here.

The naming of the components for Vue changes from kebab-case to PascalCase with an appended Vue after the syn. syn-button becomes SynVueButton:

1<!-- Webcomponents example -->
2<syn-button> My Button </syn-button>

1<!-- Vue wrapper example -->
2<SynVueButton> My Button </SynVueButton>

6. Usage of attributes

The attribute naming of the components are the same as in the documentation.

1<!-- Webcomponents example -->
2<syn-input
3  label="Nickname"
4  help-text="What would you like people to call you?"
5  required
6></syn-input>

1<!-- Vue wrapper example -->
2<SynVueInput
3  label="Nickname"
4  help-text="What would you like people to call you?"
5  required
6/>

7. Usage of events

Custom events are named in the documentation as following: syn-change, syn-clear, ... They stay the same for the Vue components:

1<SynVueButton
2  @syn-blur="handleBlur"
3  @syn-focus="handleFocus"
4  @syn-invalid="handleInvalid"
5>
6  My Button
7</SynVueButton>

If typescript is used, you can get the correct types for components and events from the @synergy-design-system/components package.

An example for how these types can be used in case of event handling, is shown below:

1<script setup lang="ts">
2  import { SynVueInput } from "@synergy-design-system/vue";
3  import type {
4    SynChangeEvent,
5    SynInput,
6  } from "@synergy-design-system/components";
7
8  const synChange = (e: SynChangeEvent) => {
9    const input = e.target as SynInput;
10    // Now we get access to all properties, methods etc. of the syn-input
11    const surname = input.value;
12    doSomething(surname);
13  };
14</script>
15
16<template>
17  <SynVueInput label="Surname" @syn-change="synChange" />
18</template>

8. Obtaining a reference to the underlying native element (e.g. for usage of methods)

Sometimes, there is a need to interact directly with the underlying native web-component. For this reason, the library exposes a nativeElement property for all vue components.

1<script setup lang="ts">
2  import { SynVueInput, SynVueButton } from "@synergy-design-system/vue";
3  import { ref } from "vue";
4
5  const count = ref<InstanceType<typeof SynVueInput> | null>(null);
6
7  const handleClick = () => {
8    // Increment the count via calling the method
9    count.value?.nativeElement?.stepUp();
10  };
11</script>
12
13<template>
14  <SynVueInput ref="count" label="My count" type="number" value="5" />
15  <SynVueButton @click="handleClick"> Increment </SynVueButton>
16</template>

9. Using two way databinding

We support Vue two way data binding for form components out of the box. You may use it in one of the following ways:

1<script setup lang="ts">
2  import { ref } from "vue";
3  import {
4    SynVueButton,
5    SynVueCheckbox,
6    SynVueTextarea,
7    SynVueInput,
8  } from "@synergy-design-system/vue";
9
10  const formValues = ref({
11    checkboxValue: false,
12    inputValue: "",
13    textAreaValue: "",
14  });
15
16  const submit = (e: Event) => {
17    e.preventDefault();
18    e.stopPropagation();
19    const target = e.target as HTMLFormElement;
20
21    const isValid = target.reportValidity();
22    if (isValid) {
23      const data = [...new FormData(target)]
24        .map(v => {
25          return `${v[0]}: ${v[1]}`;
26        })
27        .join(",\n")
28        .trim();
29      // Do something with the data
30      console.log(data);
31    }
32  };
33</script>
34
35<template>
36  <form @submit="submit">
37    <SynVueInput
38      label="Input Example"
39      name="inputValue"
40      required
41      v-model="formValues.inputValue"
42    />
43    <SynVueTextarea v-model="formValues.textAreaValue" name="textAreaValue" />
44    <SynVueCheckbox
45      v-model="formValues.checkboxValue"
46      required
47      name="checkboxValue"
48      >Agree</SynVueCheckbox
49    >
50    >
51  </form>
52</template>

---

Development

To create a new version of this package, proceed in the following way:

1. Check out the Synergy Design System Repository.
2. Run pnpm i -r to install all dependencies.
3. Build the @synergy-design-system/components package (or run pnpm build in the project root to build everything).
4. Move to to packages/_private/vue-demo and use pnpm start to spin up a local vite project using Vue and typescript to validate the build.

⚠️ The build process will always try to sync this packages package.json.version field with the latest version from @synergy-design-system/components! Therefore, it is best to not alter the version string