@trimblemaps/ether-framework

Project Ether Framework

The Project Ether Framework was developed as a common platform for all of Trimble MAPS web applications, with the additional goal of sharing with other groups within Trimble. It leverages the Trimble brand as well as some of the work done by other groups, specifically Project Origin by the SketchUp team.

Background

Project Ether is built upon and extends the Bootstrap 4 code framework. It is a responsive framework for web and mobile uses. You can use the CSS files as is, or integrate the SASS files into your own application if you wish to modify it further.

CDN

The Ether Framework can be used as is from our public CDN:

<link rel="stylesheet"href="https://styles.trimblemaps.com/css/ether.min-0.3.2.css" />

If you want to also use the Ether Framework layout (top nav, left nav, and content area) you will need to add these additional references:

<link rel="stylesheet"href="https://styles.trimblemaps.com/css/ether-layout.min-0.3.2.css" />
<script src="https://styles.trimblemaps.com/css/ether-layout.min-0.3.2.js"></script>

You do not (and should not) include additional references to Bootstrap CSS other than their Javascript links for component functions.  If you are using Angular, React, or other framework you should use an appropriate Bootstrap library.

<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous">
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js"
    integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous">
</script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js"
    integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous">
</script>

Install with NPM

Install Project Ether in your Node.js powered apps with our NPM package:

$ npm install --save-dev @trimblemaps/ether-framework

The compiled CSS files will be found in the ./node_modules/@trimblemaps/ether-framework/dist directory.

Customize using SASS

The SASS files will be found in the /scss directory.

Development

Build CSS, run dev server, and watch for changes

npm run dev

Sample page found at http://localhost:3030/

Build Package

Builds the CSS files to /dist

npm run build

File structure

Whenever possible, avoid modifying Ether or Bootstrap core files.

For Sass, that means creating your own stylesheet that imports Ether and Bootstrap so you can modify and extend it. Assuming you’re using a package manager like npm, you’ll have a file structure that looks like this:

your-project/
├── scss
│   └── custom.scss
└── node_modules/
    ├── bootstrap
    │   ├── js
    │   └── scss
    └── @trimblemaps
        └──ether-framework
            └── scss

Importing

In your custom.scss, you’ll import Ether and Bootstrap’s source Sass files. With that setup in place, you can begin to modify any of the Sass variables and maps in your custom.scss.

You can also start to add parts of Bootstrap under the // Optional section as needed. We suggest using the full import stack from our bootstrap.scss file as your starting point.

The main file to focus on is the _theme.scss file (and/or _theme-dark.scss if you want a dark look).

You should copy this file from /node_modules/@trimblemaps/ether-framework/scss/components to your own SASS directory and import your copy instead of the Project Ether version in your main SASS file.

This example shows you how you should structure your main file. The order in which files ar eimported matters.

  // Bootstrap functions
  @import "../node_modules/bootstrap/scss/functions";
  // Ether functions
  @import "../node_modules/@trimblemaps/ether-framework/scss/components/functions";

  // **** YOUR CUSTOM THEME GOES HERE ****
  @import "your_custom_sass_directory/your_copy_of_ether_theme_file";
  // Ether variables
  @import "../node_modules/@trimblemaps/ether-framework/scss/components/variables";
  // OPTIONAL - use your own variables:
  // @import "your_custom_sass_directory/copy_of_ether_variables_file";
  
  // Bootstrap variables
  @import "../node_modules/bootstrap/scss/variables";
  @import "../node_modules/bootstrap/scss/mixins";

  // Ether mixins
  @import "../node_modules/@trimblemaps/ether-framework/scss/components/mixins";
  
  // Bootstrap components (you can leave some of these out if you don't need them)
  @import "../node_modules/bootstrap/scss/reboot";
  @import "../node_modules/bootstrap/scss/type";
  @import "../node_modules/bootstrap/scss/images";
  @import "../node_modules/bootstrap/scss/code";
  @import "../node_modules/bootstrap/scss/grid";
  @import "../node_modules/bootstrap/scss/tables";
  @import "../node_modules/bootstrap/scss/forms";
  @import "../node_modules/bootstrap/scss/buttons";
  @import "../node_modules/bootstrap/scss/transitions";
  @import "../node_modules/bootstrap/scss/dropdown";
  @import "../node_modules/bootstrap/scss/button-group";
  @import "../node_modules/bootstrap/scss/input-group";
  @import "../node_modules/bootstrap/scss/custom-forms";
  @import "../node_modules/bootstrap/scss/nav";
  @import "../node_modules/bootstrap/scss/navbar";
  @import "../node_modules/bootstrap/scss/card";
  @import "../node_modules/bootstrap/scss/breadcrumb";
  @import "../node_modules/bootstrap/scss/pagination";
  @import "../node_modules/bootstrap/scss/badge";
  @import "../node_modules/bootstrap/scss/jumbotron";
  @import "../node_modules/bootstrap/scss/alert";
  @import "../node_modules/bootstrap/scss/progress";
  @import "../node_modules/bootstrap/scss/media";
  @import "../node_modules/bootstrap/scss/list-group";
  @import "../node_modules/bootstrap/scss/close";
  @import "../node_modules/bootstrap/scss/toasts";
  @import "../node_modules/bootstrap/scss/modal";
  @import "../node_modules/bootstrap/scss/tooltip";
  @import "../node_modules/bootstrap/scss/popover";
  @import "../node_modules/bootstrap/scss/carousel";
  @import "../node_modules/bootstrap/scss/spinners";
  @import "../node_modules/bootstrap/scss/utilities";
  @import "../node_modules/bootstrap/scss/print";
  
  // Ether components
  @import "../node_modules/@trimblemaps/ether-framework/scss/components/controls";
  @import "../node_modules/@trimblemaps/ether-framework/scss/components/base";

  // **** YOUR SITE SPECIFIC SASS GOES HERE ****
  @import "your_custom_sass_directory/your_project_specific_sass_files";