@rnacanvas/start-page 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -0
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Installation
|
|
2
|
+
|
|
3
|
+
With `npm`:
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
npm install @rnacanvas/start-page
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
# Usage
|
|
10
|
+
|
|
11
|
+
All exports of this package can be accessed as named imports.
|
|
12
|
+
|
|
13
|
+
```javascript
|
|
14
|
+
// an example import
|
|
15
|
+
import { StartPage } from '@rnacanvas/start-page';
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## `class StartPage`
|
|
19
|
+
|
|
20
|
+
The Start page component.
|
|
21
|
+
|
|
22
|
+
```javascript
|
|
23
|
+
var targetApp = new RNAcanvas();
|
|
24
|
+
|
|
25
|
+
var startPage = new StartPage(targetApp);
|
|
26
|
+
|
|
27
|
+
// the DOM node corresponding to the Start page
|
|
28
|
+
startPage.domNode;
|
|
29
|
+
|
|
30
|
+
startPage.domNode.style.position = 'absolute';
|
|
31
|
+
|
|
32
|
+
// the Start page is intended to occupy the entire screen area of the app
|
|
33
|
+
startPage.domNode.style.top = '0px';
|
|
34
|
+
startPage.domNode.style.right = '0px';
|
|
35
|
+
startPage.domNode.style.bottom = '0px';
|
|
36
|
+
startPage.domNode.style.left = '0px';
|
|
37
|
+
|
|
38
|
+
// open the Start page
|
|
39
|
+
document.body.append(startPage.domNode);
|
|
40
|
+
```
|