@engie-group/fluid-design-system
Advanced tools
The Fluid Design System is ENGIE’s open-source library to create, build and deliver ENGIE digital services in a more efficient way.
When installing the package via npm or importing it via CDN we recommend fixing the version with the exact package version to avoid breaking change affecting your live website. With never-ending topics like Accessibility and BRAND GUIDELINES we also have to include some minor breaking changes in some minor versions
e.g:
npm install --save @engie-group/fluid-design-system@VERSION
or
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@engie-group/fluid-design-tokens@VERSION/lib/css/tokens.css">
When you only need to include compiled CSS or JS from Fluid, you can use our CDN links:
<!-- Fonts --->
<link href="https://fonts.googleapis.com/css?family=Material+Icons|Lato:300,400,700,900&display=swap" rel="stylesheet"/>
<!-- Styles -->
<!-- Styles to set correct font properties in your website -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@engie-group/fluid-design-system@5.0.0/lib/base.css">
<!-- Styles to import tokens needed by components -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@engie-group/fluid-design-tokens@5.0.0/lib/css/tokens.css">
<!-- Styles of all components -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@engie-group/fluid-design-system@5.0.0/lib/fluid-design-system.css">
<!-- Scripts -->
<script src="https://cdn.jsdelivr.net/npm/@engie-group/fluid-design-system@5.0.0"></script>
You can install the package inside your application from npmjs
npm install @engie-group/fluid-design-system@5.0.0
Be sure to always include these fonts into the HTML head:
<link href="https://fonts.googleapis.com/css?family=Material+Icons|Lato:300,400,700,900&display=swap" rel="stylesheet"/>
You can use the built files from the lib/ directory.
Copy-paste the stylesheet <link> into your <head> before all other stylesheets to load our CSS.
<link href="/your-css-path/fluid-design-system.css" rel="stylesheet">
For e.g include the Toggle component styles only:
<link href="/your-css-path/base.css" rel="stylesheet">
<link href="/your-css-path/components/toggle/index.css" rel="stylesheet">
Not all components contain a Javascript file. Use the full library to avoid worrying about it.
Place the following <script> near the end of your pages, right before the closing </body> tag, to enable components using JS.
<html>
<body>
<!-- Engie components -->
<script src="/your-js-path/@engie-group/fluid-design-system@5.0.0/lib/fluid-design-system.js"></script>
<script src="/your-js-path/@engie-group/fluid-design-system@5.0.0/lib/auto-init.js"></script>
</body>
</html>
Include the Collapse component UMD script:
<script src="/your-js-path/@engie-group/fluid-design-system@5.0.0/lib/components/toggle/index.js"></script>
<script src="/your-js-path/@engie-group/fluid-design-system@5.0.0/lib/auto-init.js"></script>
You can import the sources files from the src/ directory. Feel free to use your asset builder (Webpack, gulp, grunt...)
Make sure to include the [Google material icons]({{ site.baseurl }}/{{ site.docs_name }}/brand/icons/#google-material-icons){:.nj-link} first if you import the entire library or icon component.
Import the library in your project:
@import "~@engie-group/fluid-design-tokens/lib/css/tokens.css";
@import "~@engie-group/fluid-design-system/lib/fluid-design-system.css";
@import "~@engie-group/fluid-design-system/lib/base.css";
E.g: Import the Toggle component file only:
@import "~@engie-group/fluid-design-system/src/base";
@import "~@engie-group/fluid-design-system/src/components/toggle/_index";
Components can be initiated manually
import {Collapse} from '@engie-group/fluid-design-system';
document.addEventListener('DOMContentLoaded', function(event) {
Toggle.init();
});
If you have any issues while getting set up with Fluid Design System, please create an issue or a request on our library git repository.
FAQs
The Fluid Design System is ENGIE’s open-source library to create, build and deliver ENGIE digital services in a more efficient way.
We found that @engie-group/fluid-design-system demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
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.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.