@engie-group/fluid-design-system
Advanced tools
ENGIE Fluid is open-source design system to create, build and deliver ENGIE digital services in a more efficient way.
Welcome to the Fluid Design System by ENGIE. It's a library of UI components written in HTML/CSS/Vanilla JS. To begin with, you have multiple ways to work with our design system. Start with the installation and then feel free to explore the different sections of the design system to start building applications based on ENGIE standards. https://design.engie.com/
Install the package inside your new application: npm install @engie-group/fluid-design-system
For an alternative use (zip, cdn), please read the dedicated section https://design.engie.com/design-system/getting-started/developers/introduction/#quick-start
You can start using the design system through two methods :
The package has the following file structure:
.
├── CHANGELOG.md
├── README.md
├── lib
│ ├── components
│ │ ├── ...
│ │ ├── toggle/
│ │ └── ...
│ ├── body-and-reset.css
│ ├── fluid-design-system.css
│ ├── fluid-design-system.d.ts
│ ├── fluid-design-system.js
└── src
├── components
│ ├── ...
│ ├── toggle/
│ └── ...
├── globals
│ ├── scss/
│ └── ts/
├── body-and-reset.scss
├── fluid-design-system.scss
└── fluid-design-system.ts
You can use the built files from the lib/ directory.
Make sure to include the Google material icons first.
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">
Include the Toggle component styles only:
<link href="/your-css-path/components/toggle/index.css" rel="stylesheet">
Place the following <script> near the end of your pages, right before the closing </body> tag, to enable them.
<script src="/your-js-path/fluid-design-system.js"></script>
Include the Toggle component scripts only:
<script src="/your-js-path/components/toggle/index.js"></script>
You can import the sources files from the src/ directory. Feel free to use your asset builder (Webpack, gulp, grunt...)
Fonts path: In case you have to resolve the relative path to fonts files you can set the $icon-font-path variable or use resolve-url-loader with webpack.
Make sure to include the Google material icons first.
Import the library in your project:
@import "~@engie-group/fluid-design-system/src/fluid-design-system.scss";
Import the Toggle component file only:
@import "~@engie-group/fluid-design-system/src/components/toggle";
If the import is not working, use this one instead (see Index Files):
@import "~@engie-group/fluid-design-system/src/components/toggle/_index";
Import the library in your project:
import NJ from '@engie-group/fluid-design-system';
Initialize all components:
document.addEventListener('DOMContentLoaded', function(event) {
NJ.AutoInit();
});
Import the library component in your project.
import Toggle from '@engie-group/fluid-design-system/lib/components/toggle';
Initialize the component:
document.addEventListener('DOMContentLoaded', function(event) {
Toggle.init();
});
If you have any issues while getting set up with ENGIE Design System, please create an issue here.
FAQs
The Fluid Design System is ENGIE’s open-source library to create, build and deliver ENGIE digital services in a more efficient way.
The npm package @engie-group/fluid-design-system receives a total of 530 weekly downloads. As such, @engie-group/fluid-design-system popularity was classified as not popular.
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.