Skip to content

Commit

Permalink
Chore: Update to new 'Elements' branding (#193)
Browse files Browse the repository at this point in the history
- Update references from UI Kits -> UI Elements
- Update license notification in source files
- Remove auto-format on save (this messes with non-JS files)
  • Loading branch information
tonyjin authored and priyajeet committed Jun 29, 2017
1 parent 53527c0 commit 4995798
Show file tree
Hide file tree
Showing 7 changed files with 144 additions and 144 deletions.
1 change: 0 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// Place your settings in this file to overwrite default and user settings.
{
"editor.formatOnSave": true,
"editor.rulers": [
120
],
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Before a contribution can be merged into this project, please fill out the Contr

https://developer.box.com/v2.0/docs/ui-kits-contribution-license

To learn more about CLAs and why they are important to the UI kit projects, please see the [Wikipedia entry](http://en.wikipedia.org/wiki/Contributor_License_Agreement).
To learn more about CLAs and why they are important to the UI Element projects, please see the [Wikipedia entry](http://en.wikipedia.org/wiki/Contributor_License_Agreement).

## Code of Conduct

Expand Down
14 changes: 7 additions & 7 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
SOFTWARE LICENSE AGREEMENT
(v.20170516)

BOX UI KITS
BOX UI ELEMENTS

This "Agreement" forms a legally binding agreement between Box (as defined in
Section 14) and you ("Developer") that governs Developer's right to access and
Expand Down Expand Up @@ -48,8 +48,8 @@ services for their respective governing terms.
thereto) or to modify the SDK at any time in its sole discretion.
Free/open source software components distributed in this SDK are licensed
to Developer under the terms of the applicable free/open source license
agreements and such free/open source software licenses can be found at
https://cloud.box.com/v/preview-licenses-v1.
agreements and such free/open source software licenses can be found in
the THIRD_PARTY_LICENSES file in the same source directory as this file.

2. Use Rights & Requirements.
a. Subject to Developer's compliance with the terms of this Agreement,
Expand Down Expand Up @@ -109,12 +109,12 @@ services for their respective governing terms.
4. Contributions. Developer Contributions (as defined in the "Contributor
License Agreement" (CLA)), made by the Developer pursuant to the rights
granted or permitted under this Agreement, are subject to the following:
a. Developer shall comply with the Contribution policy set forth here:
https://github.com/box/box-content-preview/blob/master/CONTRIBUTING.md;
a. Developer shall comply with the Contribution policy set forth in the
CONTRIBUTING.md file in the same source directory as this file;
and
b. For each Contribution, Developer shall agree to the Box "Contributor
License Agreement" (or "CLA") located here:
https://developer.box.com/docs/ui-kits-contribution-license.
https://developer.box.com/docs/box-ui-elements-cla.

5. Feedback. Developer may, from time to time, provide feedback to Box
concerning the functionality and performance of the SDK or Box Service
Expand Down Expand Up @@ -345,7 +345,7 @@ services for their respective governing terms.


Exhibit A
BOX UI KIT ACCEPTABLE USE POLICY
BOX UI ELEMENT ACCEPTABLE USE POLICY

Acceptable Use Policy. Developer shall not, and shall not use the SDKs to:
a) Do anything illegal, or facilitate, promote or encourage any illegal
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

[Box Content Preview](https://docs.box.com/docs/box-content-preview)
====================================================================
The Box Content Preview Javascript UI Kit allows developers to easily embed high quality and interactive previews of Box files in their desktop or mobile web application. The library fetches information about the file and its converted representations through the Box API, chooses the appropriate viewer for the file type, dynamically loads the necessary static assets and file representations, and finally renders the file. Box Content Preview also allows previews of multiple files to be loaded in the same container and exposes arrows to navigate between those files.
The Box Content Preview UI Element allows developers to easily embed high quality and interactive previews of Box files in their desktop or mobile web application. The JavaScript library fetches information about the file and its converted representations through the Box API, chooses the appropriate viewer for the file type, dynamically loads the necessary static assets and file representations, and finally renders the file. Box Content Preview also allows previews of multiple files to be loaded in the same container and exposes arrows to navigate between those files.

This UI Kit powers Preview in the main Box web application as well as the 'expiring embed' Box API endpoint.
This UI Element powers Preview in the main Box web application as well as the 'expiring embed' Box API endpoint.

Browser Support
---------------
Expand Down Expand Up @@ -37,7 +37,7 @@ Box Content Preview supports 100+ file types, including most document and image

Usage
-----
You can self-host the Box Content Preview UI Kit or reference the versions available on Box's CDN.
You can self-host the Box Content Preview UI Element or reference the versions available on Box's CDN.

```html
<!DOCTYPE html>
Expand Down
6 changes: 3 additions & 3 deletions THIRD_PARTY_LICENSES
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
The Box Content Viewer uses third-party libraries which may be distributed
under licenses different than the Box Content Viewer itself. For the
The Box Content Preview UI Element uses third-party libraries which may be
distributed under licenses different than the Box UI Element itself. For the
libraries bundled at build-time, please look at package.json. The other
libraries are:

1) pdf.js
1. pdf.js
---------
Source code: https://github.com/mozilla/pdf.js
License: Apache License, Version 2.0
Expand Down
14 changes: 9 additions & 5 deletions build/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ const BundleAnalyzerPlugin = require('webpack-bundle-analyzer')
const version = isRelease ? require('../package.json').version : 'dev';
const fs = require('fs');

const licenseNotification = `Box UI Element
Copyright 2016-2017 Box, Inc. All rights reserved.
This source code is licensed under the Box Software License Agreement found
in the LICENSE file in the root directory of this source tree. Additional
third party license disclosures can be found in the THIRD_PARTY_LICENSES
file in the same directory.`;

let rsyncLocation = '';
if (fs.existsSync('build/rsync.json')) {
/* eslint-disable */
Expand Down Expand Up @@ -117,11 +125,7 @@ function updateConfig(conf, language, index) {
);

// Add license message to top of code
config.plugins.push(
new BannerPlugin(
'Box Content Preview UI Kit | Copyright 2016-2017 Box | Licenses: https://cloud.box.com/v/preview-licenses-v1'
)
);
config.plugins.push(new BannerPlugin(licenseNotification));
}

return config;
Expand Down
245 changes: 121 additions & 124 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,126 +1,123 @@
{
"name": "box-content-preview",
"version": "0.130.0",
"description": "Box Content Preview UI Kit",
"author": "Box (https://www.box.com/)",
"license": "SEE LICENSE IN LICENSE",
"repository": {
"type": "git",
"url": "[email protected]:box/box-preview.git"
},
"devDependencies": {
"autobind-decorator": "^1.3.4",
"autoprefixer": "^6.7.7",
"babel-core": "^6.24.0",
"babel-eslint": "^7.1.1",
"babel-loader": "^6.4.1",
"babel-plugin-istanbul": "^4.0.0",
"babel-plugin-transform-class-properties": "^6.23.0",
"babel-plugin-transform-decorators-legacy": "^1.3.4",
"babel-plugin-transform-object-rest-spread": "^6.23.0",
"babel-plugin-transform-require-ignore": "0.1.0",
"babel-polyfill": "^6.23.0",
"babel-preset-es2015": "^6.24.0",
"babel-preset-es2016": "^6.22.0",
"babel-preset-react": "^6.23.0",
"chai": "^3.5.0",
"chai-as-promised": "5.3.0",
"chai-dom": "^1.4.3",
"conventional-changelog-lint": "^1.1.7",
"css-loader": "^0.27.3",
"cssnano-cli": "^1.0.5",
"deepmerge": "^1.3.2",
"es6-promise": "^4.1.0",
"eslint": "^3.17.1",
"eslint-config-airbnb": "^14.1.0",
"eslint-config-prettier": "^2.1.1",
"eslint-import-resolver-webpack": "^0.8.1",
"eslint-plugin-babel": "^4.1.1",
"eslint-plugin-import": "^2.2.0",
"eslint-plugin-jsx-a11y": "^4.0.0",
"eslint-plugin-react": "^6.10.0",
"extract-text-webpack-plugin": "2.1.0",
"fetch-mock": "^5.9.4",
"fetch-mock-forwarder": "^1.0.0",
"file-loader": "^0.10.1",
"husky": "^0.13.4",
"i18n-webpack-plugin": "^0.3.0",
"karma": "^1.5.0",
"karma-chai": "^0.1.0",
"karma-chai-as-promised": "^0.1.2",
"karma-chai-dom": "^1.1.0",
"karma-chai-sinon": "^0.1.5",
"karma-chrome-launcher": "^2.0.0",
"karma-coverage": "^1.1.1",
"karma-fixture": "^0.2.6",
"karma-html2js-preprocessor": "^1.1.0",
"karma-junit-reporter": "^1.2.0",
"karma-mocha": "^1.3.0",
"karma-mocha-reporter": "^2.2.2",
"karma-phantomjs-launcher": "^1.0.4",
"karma-sinon": "^1.0.5",
"karma-sinon-stub-promise": "^1.0.0",
"karma-sourcemap-loader": "^0.3.7",
"karma-webpack": "^2.0.3",
"lint-staged": "^3.4.2",
"lodash.clonedeep": "^4.5.0",
"lodash.debounce": "^4.0.8",
"lodash.throttle": "^4.1.1",
"mocha": "^3.2.0",
"mock-local-storage": "^1.0.2",
"mojito-rb-gen": "^0.0.1",
"node-sass": "^4.5.0",
"optimize-css-assets-webpack-plugin": "^1.3.0",
"phantomjs-prebuilt": "^2.1.14",
"postcss-loader": "^1.3.3",
"prettier": "^1.3.1",
"prettier-eslint-cli": "^4.0.1",
"rangy": "^1.3.0",
"raw-loader": "^0.5.1",
"react": "^15.4.2",
"react-addons-shallow-compare": "^15.4.2",
"react-dom": "^15.4.2",
"react-virtualized": "^9.3.0",
"sass-loader": "^6.0.3",
"sinon": "1.17.7",
"sinon-chai": "2.8.0",
"sinon-stub-promise": "^4.0.0",
"string-replace-loader": "^1.0.5",
"style-loader": "^0.14.1",
"stylelint": "^7.9.0",
"stylelint-config-standard": "^16.0.0",
"stylelint-order": "^0.4.1",
"webpack": "^2.2.1",
"webpack-bundle-analyzer": "^2.8.2",
"whatwg-fetch": "^2.0.3"
},
"scripts": {
"build": "yarn run clean && yarn run build-rb && yarn run lint && yarn run dev",
"build-ci": "./node_modules/.bin/webpack --progress --colors --config build/webpack.config.js",
"build-rb": "mojito-rb-gen -s src/i18n -o src/i18n/json -b en-US.properties",
"ci": "yarn run clean && yarn run build-rb && yarn run lint && yarn run test && yarn run build-ci",
"clean": "rm -rf dist && rm -rf reports/coverage && rm -rf src/i18n/json",
"commitmsg": "conventional-changelog-lint -e",
"debug": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js --no-single-run --auto-watch",
"dev": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack --progress --colors --config build/webpack.config.js",
"lint": "NODE_ENV=dev ./node_modules/.bin/eslint src/lib && ./node_modules/.bin/stylelint 'src/lib/**/*.scss'",
"precommit": "lint-staged",
"prepush": "yarn run lint",
"prettier": "prettier-eslint \"src/lib/**/*.js\" --print-width 120 --single-quote --tab-width 4 --write",
"prod": "BABEL_ENV=production NODE_ENV=production node --max_old_space_size=4096 ./node_modules/webpack/bin/webpack.js --progress --colors --config build/webpack.config.js",
"release": "yarn run clean && yarn run build-rb && yarn run lint && yarn run test && yarn run prod",
"test": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js",
"upgrade-pdfjs": "./build/upgrade_pdfjs.sh && ./build/minify_pdfjs.sh",
"watch": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack --watch --progress --colors --config build/webpack.config.js",
"major": "./build/release.sh -m",
"minor": "./build/release.sh -n",
"patch": "./build/release.sh -p"
},
"lint-staged": {
"src/lib/**/*.js": [
"prettier-eslint --print-width 120 --single-quote --tab-width 4 --write",
"git add"
]
},
"dependencies": {}
"name": "box-content-preview",
"version": "0.130.0",
"description": "Box Content Preview UI Element",
"author": "Box (https://www.box.com/)",
"license": "SEE LICENSE IN LICENSE",
"repository": {
"type": "git",
"url": "[email protected]:box/box-content-preview.git"
},
"devDependencies": {
"autobind-decorator": "^1.3.4",
"autoprefixer": "^6.7.7",
"babel-core": "^6.24.0",
"babel-eslint": "^7.1.1",
"babel-loader": "^6.4.1",
"babel-plugin-istanbul": "^4.0.0",
"babel-plugin-transform-class-properties": "^6.23.0",
"babel-plugin-transform-decorators-legacy": "^1.3.4",
"babel-plugin-transform-object-rest-spread": "^6.23.0",
"babel-plugin-transform-require-ignore": "0.1.0",
"babel-polyfill": "^6.23.0",
"babel-preset-es2015": "^6.24.0",
"babel-preset-es2016": "^6.22.0",
"babel-preset-react": "^6.23.0",
"chai": "^3.5.0",
"chai-as-promised": "5.3.0",
"chai-dom": "^1.4.3",
"conventional-changelog-lint": "^1.1.7",
"css-loader": "^0.27.3",
"cssnano-cli": "^1.0.5",
"deepmerge": "^1.3.2",
"es6-promise": "^4.1.0",
"eslint": "^3.17.1",
"eslint-config-airbnb": "^14.1.0",
"eslint-config-prettier": "^2.1.1",
"eslint-import-resolver-webpack": "^0.8.1",
"eslint-plugin-babel": "^4.1.1",
"eslint-plugin-import": "^2.2.0",
"eslint-plugin-jsx-a11y": "^4.0.0",
"eslint-plugin-react": "^6.10.0",
"extract-text-webpack-plugin": "2.1.0",
"fetch-mock": "^5.9.4",
"fetch-mock-forwarder": "^1.0.0",
"file-loader": "^0.10.1",
"husky": "^0.13.4",
"i18n-webpack-plugin": "^0.3.0",
"karma": "^1.5.0",
"karma-chai": "^0.1.0",
"karma-chai-as-promised": "^0.1.2",
"karma-chai-dom": "^1.1.0",
"karma-chai-sinon": "^0.1.5",
"karma-chrome-launcher": "^2.0.0",
"karma-coverage": "^1.1.1",
"karma-fixture": "^0.2.6",
"karma-html2js-preprocessor": "^1.1.0",
"karma-junit-reporter": "^1.2.0",
"karma-mocha": "^1.3.0",
"karma-mocha-reporter": "^2.2.2",
"karma-phantomjs-launcher": "^1.0.4",
"karma-sinon": "^1.0.5",
"karma-sinon-stub-promise": "^1.0.0",
"karma-sourcemap-loader": "^0.3.7",
"karma-webpack": "^2.0.3",
"lint-staged": "^3.4.2",
"lodash.clonedeep": "^4.5.0",
"lodash.debounce": "^4.0.8",
"lodash.throttle": "^4.1.1",
"mocha": "^3.2.0",
"mock-local-storage": "^1.0.2",
"mojito-rb-gen": "^0.0.1",
"node-sass": "^4.5.0",
"optimize-css-assets-webpack-plugin": "^1.3.0",
"phantomjs-prebuilt": "^2.1.14",
"postcss-loader": "^1.3.3",
"prettier": "^1.3.1",
"prettier-eslint-cli": "^4.0.1",
"rangy": "^1.3.0",
"raw-loader": "^0.5.1",
"react": "^15.4.2",
"react-addons-shallow-compare": "^15.4.2",
"react-dom": "^15.4.2",
"react-virtualized": "^9.3.0",
"sass-loader": "^6.0.3",
"sinon": "1.17.7",
"sinon-chai": "2.8.0",
"sinon-stub-promise": "^4.0.0",
"string-replace-loader": "^1.0.5",
"style-loader": "^0.14.1",
"stylelint": "^7.9.0",
"stylelint-config-standard": "^16.0.0",
"stylelint-order": "^0.4.1",
"webpack": "^2.2.1",
"webpack-bundle-analyzer": "^2.8.2",
"whatwg-fetch": "^2.0.3"
},
"scripts": {
"build": "yarn run clean && yarn run build-rb && yarn run lint && yarn run dev",
"build-ci": "./node_modules/.bin/webpack --progress --colors --config build/webpack.config.js",
"build-rb": "mojito-rb-gen -s src/i18n -o src/i18n/json -b en-US.properties",
"ci": "yarn run clean && yarn run build-rb && yarn run lint && yarn run test && yarn run build-ci",
"clean": "rm -rf dist && rm -rf reports/coverage && rm -rf src/i18n/json",
"commitmsg": "conventional-changelog-lint -e",
"debug": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js --no-single-run --auto-watch",
"dev": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack --progress --colors --config build/webpack.config.js",
"lint": "NODE_ENV=dev ./node_modules/.bin/eslint src/lib && ./node_modules/.bin/stylelint 'src/lib/**/*.scss'",
"precommit": "lint-staged",
"prepush": "yarn run lint",
"prettier": "prettier-eslint \"src/lib/**/*.js\" --print-width 120 --single-quote --tab-width 4 --write",
"prod": "BABEL_ENV=production NODE_ENV=production node --max_old_space_size=4096 ./node_modules/webpack/bin/webpack.js --progress --colors --config build/webpack.config.js",
"release": "yarn run clean && yarn run build-rb && yarn run lint && yarn run test && yarn run prod",
"test": "NODE_ENV=test ./node_modules/.bin/karma start build/karma.conf.js",
"upgrade-pdfjs": "./build/upgrade_pdfjs.sh && ./build/minify_pdfjs.sh",
"watch": "BABEL_ENV=dev NODE_ENV=dev ./node_modules/.bin/webpack --watch --progress --colors --config build/webpack.config.js",
"major": "./build/release.sh -m",
"minor": "./build/release.sh -n",
"patch": "./build/release.sh -p"
},
"lint-staged": {
"src/lib/**/*.js": ["prettier-eslint --print-width 120 --single-quote --tab-width 4 --write", "git add"]
},
"dependencies": {}
}

0 comments on commit 4995798

Please sign in to comment.