Ellie Mae EPC Components
Introduction
This library provides Encompass Partner Connect (EPC) service Partners the ability to quickly create common UI components for their integration UI - while simultaneously adhering to Ellie Mae's UX style guidelines for Partner integrations. The detailed UX style guidelines for EPC Partner integrations can be found on on the Encompass Partner Connect portal. Navigate to the UX Style Guidelines page under the Resources section of the portal to access this documentation.
Composition
The components exposed in this library are built using native JavaScript, SCSS and HTML5. For Partners who choose to use popular web frameworks for building their UI - such as Angular, React or Vue - these native components can be used as a point of reference when implementing common components in the framework of choice.
Documentation
Partners can find documentation for each of the common components exposed in this library - along with detailed guidelines on how to use these components in their project - on the Encompass Partner Connect portal. Navigate to the Common Components Library page under the Resources section of the portal to access this documentation.
Development Setup
-
To use this library, you will need to have Node Package Manager (npm) installed in your development environment. Documentation on installing npm in your environment can be found here.
-
To install this library for use in your project - run the following command in your project directory:
npm install @elliemae/em-epc-components --save
User Guidelines
In order to use the CSS styling and JavaScript functionality exposed by the Partner Common Components library, you will need to import the libraries style.css and app.bundle.js files:
import '@elliemae/em-epc-components/dist/style.css';
import * as EPC from '@elliemae/em-epc-components/dist/app.bundle.js';