-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add(modules) widget module * add(docs) widget overview
- Loading branch information
1 parent
19114ef
commit f368dea
Showing
10 changed files
with
102 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# @deck.gl/widgets | ||
|
||
Widgets are UI components around the WebGL canvas to offer controls and information for a better user experience. | ||
|
||
This module contains the following extensions: | ||
|
||
- [FullscreenWidget](./fullscreen-widget.md) | ||
|
||
## Installation | ||
|
||
### Install from NPM | ||
|
||
```bash | ||
npm install deck.gl | ||
# or | ||
npm install @deck.gl/core @deck.gl/widgets | ||
``` | ||
|
||
```js | ||
import {FullscreenWidget} from '@deck.gl/widgets'; | ||
new FullscreenWidget({}); | ||
``` | ||
|
||
### Include the Standalone Bundle | ||
|
||
```html | ||
<script src="https://unpkg.com/deck.gl@^8.10.0/dist.min.js"></script> | ||
<!-- or --> | ||
<script src="https://unpkg.com/@deck.gl/core@^8.10.0/dist.min.js"></script> | ||
<script src="https://unpkg.com/@deck.gl/widgets@^8.10.0/dist.min.js"></script> | ||
``` | ||
|
||
```js | ||
new deck.FullscreenWidget({}); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# @deck.gl/widgets | ||
|
||
UI widgets for deck.gl. Provides DOM-based controls and common UI components that seamlessly integrate with deck.gl. | ||
|
||
See [deck.gl](http://deck.gl) for documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
export * from '../core/bundle/peer-dependency'; | ||
|
||
export * from './src'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{ | ||
"name": "@deck.gl/widgets", | ||
"description": "UI widgets for deck.gl", | ||
"license": "MIT", | ||
"version": "8.10.0-alpha.1", | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"keywords": [ | ||
"webgl", | ||
"visualization", | ||
"components", | ||
"widgets" | ||
], | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/visgl/deck.gl.git" | ||
}, | ||
"main": "dist/es5/index.js", | ||
"module": "dist/esm/index.js", | ||
"files": [ | ||
"dist", | ||
"src", | ||
"typed", | ||
"dist.min.js" | ||
], | ||
"sideEffects": false, | ||
"scripts": { | ||
"build-bundle": "ocular-bundle ./bundle.ts", | ||
"prepublishOnly": "npm run build-bundle && npm run build-bundle -- --env=dev" | ||
}, | ||
"dependencies": { | ||
"@babel/runtime": "^7.0.0" | ||
}, | ||
"peerDependencies": { | ||
"@deck.gl/core": "^8.0.0" | ||
}, | ||
"gitHead": "13ace64fc2cee08c133afc882fc307253489a4e4" | ||
} |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"extends": "../../tsconfig.module.json", | ||
"include": ["src/**/*"], | ||
"exclude": ["node_modules"], | ||
"compilerOptions": { | ||
"composite": true, | ||
"rootDir": "src", | ||
"outDir": "typed" | ||
}, | ||
"references": [ | ||
{"path": "../core"} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters