We recommend fixing the version with the exact package version to avoid breaking changes affecting your live website. Moreover, we recommend checking the CHANGELOG before updating the package after a release.

Getting started

This package can be installed directly with NPM:

# Using npm
npm install --save-exact @engie-group/fluid-design-system-vue @engie-group/fluid-design-tokens

# Using pnpm
pnpm add --save-exact @engie-group/fluid-design-system-vue @engie-group/fluid-design-tokens

# Using yarn
yarn add --save-exact @engie-group/fluid-design-system-vue @engie-group/fluid-design-tokens

ℹ️ If you use deprecated components or need the reboot.css, you will need to install and use some styles from the @engie-group/fluid-4-deprecated package.

Please refer to the @engie-group/fluid-4-deprecated README.md for more information.
# Using npm
npm install @engie-group/fluid-4-deprecated

# Using pnpm
pnpm add @engie-group/fluid-4-deprecated

# Using yarn
yarn add @engie-group/fluid-4-deprecated

Fonts and Icons

In order for the components to work properly, you need to include the Material Icons and Lato font in your project.

You should include them in your HTML <head>:

<!-- Material icons, Lato font and Roboto Mono font -->
<link href="https://fonts.googleapis.com/css?family=Material+Icons|Lato:300,400,700,900|Roboto+Mono:300,400,700,900&display=swap" rel="stylesheet"/>

CSS

Component styling is based on CSS classes and some CSS variables (called design tokens). In order for each component to be rendered as expected, you need to include a CSS file as global stylesheet in your project.

You must include it in your HTML <head>:

<!-- Fluid design tokens as CSS variables -->
<link href="<your-relative-path-to-node_modules>/@engie-group/fluid-design-tokens/lib/css/token.css" rel="stylesheet">

or import it in your main JavaScript file:

import "@engie-group/fluid-design-tokens/css";

or in your CSS entry file :

@import '@engie-group/fluid-design-tokens/css';

ℹ️ We recommend including it before your own stylesheets to avoid any conflicts.

Documentation and usage

For a better comprehension of the components and their usage, we recommend checking our Storybook documentation.

For Fluid overall documentation, you can check our Fluid documentation.

If you have correctly followed the installation steps, you should be able to use Fluid components in your project.

All components are exported in @engie-group/fluid-design-system-vue:

<script setup>
  import { Button } from "@engie-group/fluid-design-system-vue";

  function sayHello() {
    console.log("Hello world!");
  }
</script>

<template>
  <button emphasis="subtle" @click="sayHello">Do an action</button>
</template>

Troubleshooting and feature requests

If you encounter any issues, or you want any component or feature to be implemented, please create an issue or a feature request on our GitHub repository.

Keywords

FAQs

What is @engie-group/fluid-design-system-vue?

Is @engie-group/fluid-design-system-vue popular?

Is @engie-group/fluid-design-system-vue well maintained?

Package last updated on 06 Dec 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install