@trimblemaps/ether-framework - npm Package Compare versions

Comparing version 0.1.31 to 0.1.32

package.json

 {
   "name": "@trimblemaps/ether-framework",
-  "version": "0.1.31",
+  "version": "0.1.32",
   "license": "MIT",
@@ -27,5 +27,6 @@ "description": "The Project Ether Framework was developed as a common platform for all Trimble web applications. 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.",
     "css:version": "node file-versioner.js",
-    "css:deploy": "cross-env s3-deploy './dist/**/*+(.css|.js)' --cwd './dist/' --region us-east-1 --bucket trimblemaps-styles/css --preventUpdates --immutable",
-    "css:deploy-dev": "cross-env s3-deploy './dist/**/*+(.css|.js)' --cwd './dist/' --region us-east-1 --bucket trimblemaps-styles/dev/css --preventUpdates --immutable",
-    "css:deploy-qa": "cross-env s3-deploy './dist/**/*+(.css|.js)' --cwd './dist/' --region us-east-1 --bucket trimblemaps-styles/qa/css --preventUpdates --immutable",
+    "deploy:dev": "cross-env s3-deploy './dist/**/*+(.css|.js)' --cwd './dist/' --region us-east-1 --bucket dev-styles-trimblemaps/css --preventUpdates --immutable",
+    "deploy:preprod": "cross-env s3-deploy './dist/**/*+(.css|.js)' --cwd './dist/' --region us-east-1 --bucket preprod-styles-trimblemaps/css --preventUpdates --immutable",
+    "deploy:prod": "cross-env s3-deploy './dist/**/*+(.css|.js)' --cwd './dist/' --region us-east-1 --bucket prod-styles-trimblemaps/css --preventUpdates --immutable",
+    "deploy:qa": "cross-env s3-deploy './dist/**/*+(.css|.js)' --cwd './dist/' --region us-east-1 --bucket alkqa-styles-trimblemaps/css --preventUpdates --immutable",
     "test-package": "npm pack && tar -xvzf *.tgz && rm -rf package *.tgz",
@@ -41,3 +42,3 @@ "test:pattern": "shx mkdir -p temp && copyfiles -f \"./dist/**/*+(.css|.js)\" temp",
   "dependencies": {
-    "bootstrap": "^4.2.1"
+    "bootstrap": "4.2.1"
   },
@@ -44,0 +45,0 @@ "devDependencies": {

README.md

@@ -11,12 +11,28 @@ # Project Ether Framework
 
-The Project Ether Framework can be used from our CDN.
+The Ether Framework can be used as is from our public CDN:
 
-`<link rel="stylesheet" href="https://cdn.trimblemaps.com/ether/0.1.29/ether.css">`
+```html
+<link rel="stylesheet"href="https://styles.trimblemaps.com/css/ether.min-0.1.32.css" />
+```
 
-`<link rel="stylesheet" href="https://cdn.trimblemaps.com/ether/0.1.29/ether-dark.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:
 
-## JavaScript
+```html
+<link rel="stylesheet"href="https://styles.trimblemaps.com/css/ether-layout.min-0.1.32.css" />
+<script src="https://styles.trimblemaps.com/css/ether-layout.min-0.1.32.js"></script>
+```
 
-A number of the HTML components require JavaScript to function properly. You must inlcude the Bootstrap 4 and JQuery dependencies to use these. Refer to [Bootstrap's Guide](https://getbootstrap.com/docs/4.1/getting-started/introduction/#js) to learn where to get these files.
+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.
 
+```html
+<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
@@ -36,3 +52,3 @@
 
-Builds CSS, runs dev server, and watches for changes
+Build CSS, run dev server, and watch for changes
 
@@ -78,5 +94,5 @@ ```bash
 
-The main file to focus on is the `_theme.scss` file (and/or `_theme-dark.scss` if you want a dark look.
+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/project-ether-framework/scss/components` to your own SASS directory and import your copy instead of the Project Ether version in your main SASS file.
+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.
 
@@ -89,12 +105,8 @@ This example shows you how you should structure your main file. The order in which files ar eimported matters.
   // Ether functions
-  @import "components/functions";
-  
-  //Fonts
-  @import url('https://fonts.googleapis.com/css?family=Open+Sans:400,600,700');
-  @import url('https://fonts.googleapis.com/css?family=Rubik:300,400,600,700');
-  
-  // **** YOUR CUSTOM CODE GOES HERE ****
+  @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";
-
-  @import "../node_modules/project-ether-framework/scss/components/variables";
+  // Ether variables
+  @import "../node_modules/@trimblemaps/ether-framework/scss/components/variables";
   // OPTIONAL - use your own variables:
@@ -106,4 +118,7 @@ // @import "your_custom_sass_directory/copy_of_ether_variables_file";
   @import "../node_modules/bootstrap/scss/mixins";
+
+  // Ether mixins
+  @import "../node_modules/@trimblemaps/ether-framework/scss/components/mixins";
   
-  // Bootstrap components
+  // Bootstrap components (you can leave some of these out if you don't need them)
   @import "../node_modules/bootstrap/scss/reboot";
@@ -144,9 +159,7 @@ @import "../node_modules/bootstrap/scss/type";
   // Ether components
-  @import "../node_modules/project-ether-framework/scss/components/mixins";
-  @import "../node_modules/project-ether-framework/scss/components/controls";
-  @import "../node_modules/project-ether-framework/scss/components/base";
-  @import "../node_modules/project-ether-framework/scss/components/layout";
+  @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_sass_files";
+  @import "your_custom_sass_directory/your_project_specific_sass_files";
 ```

No alert changes

Improved metrics

Total package byte prevSize

3071202

increased by1.83%

Lines of code

28709

increased by0.22%

Number of lines in readme file

160

increased by8.84%

Dependency changes

• + Addedbootstrap@4.2.1(transitive)

• - Removedbootstrap@4.6.2(transitive)

• Updatedbootstrap@4.2.1