Skip to content

Commit

Permalink
chore: release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
WoodNeck committed Jul 10, 2021
1 parent 0715e3d commit a37762d
Show file tree
Hide file tree
Showing 84 changed files with 5,769 additions and 1,040 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.DS_Store
node_modules/
declaration/
dist/
test/manual/dist/

demo/release/
TODO.md
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,8 @@ const signboard = new SignBoard("#test", "./video/Astronaut.mp4", { contentType:
## License
[MIT](https://github.com/WoodNeck/signboard/blob/master/LICENSE)

## Demo
[Demo](https://woodneck.github.io/signboard/)

## Browser Coverage
- Evergreen browsers (No IE)
30 changes: 30 additions & 0 deletions demo/docs/api/CODE.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
custom_edit_url: null
---

```ts
const CODE
```

### CODE {#CODE}

<div className="bulma-tags">

</div>

Error codes of [SignBoardError](SignBoardError)

**Type**: object

|PROPERTY|TYPE|DESCRIPTION|
|:---:|:---:|:---:|
|WRONG_TYPE|number|0|
|WRONG_OPTION|number|1|
|ELEMENT_NOT_FOUND|number|2|
|CANVAS_NOT_FOUND|number|3|
|WEBGL_NOT_SUPPORTED|number|4|
|FAILED_COMPILE_SHADER|number|5|
|FAILED_COMPILE_PROGRAM|number|6|
|FAILED_TO_LOAD_IMAGE|number|7|
|TEXTURE_NOT_INITIALIZED|number|8|

28 changes: 28 additions & 0 deletions demo/docs/api/CONTENT_TYPE.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
custom_edit_url: null
---

```ts
const CONTENT_TYPE
```

### CONTENT_TYPE {#CONTENT_TYPE}

<div className="bulma-tags">

</div>

A constant for the [contentType](SignBoard#contentType) option

**Type**: object

|PROPERTY|TYPE|DESCRIPTION|
|:---:|:---:|:---:|
|IMAGE|string|"image"|
|VIDEO|string|"video"|
|TEXT|string|"text"|

```ts
import { CONTENT_TYPE } from "signboard";
```

30 changes: 30 additions & 0 deletions demo/docs/api/ERROR_CODE.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
custom_edit_url: null
---

```ts
const ERROR_CODE
```

### ERROR_CODE {#ERROR_CODE}

<div className="bulma-tags">

</div>

Error codes of [SignBoardError](SignBoardError)

**Type**: object

|PROPERTY|TYPE|DESCRIPTION|
|:---:|:---:|:---:|
|WRONG_TYPE|number|0|
|WRONG_OPTION|number|1|
|ELEMENT_NOT_FOUND|number|2|
|CANVAS_NOT_FOUND|number|3|
|WEBGL_NOT_SUPPORTED|number|4|
|FAILED_COMPILE_SHADER|number|5|
|FAILED_COMPILE_PROGRAM|number|6|
|FAILED_TO_LOAD_IMAGE|number|7|
|TEXTURE_NOT_INITIALIZED|number|8|

30 changes: 30 additions & 0 deletions demo/docs/api/OBJECT_FIT.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
custom_edit_url: null
---

```ts
const OBJECT_FIT
```

### OBJECT_FIT {#OBJECT_FIT}

<div className="bulma-tags">

</div>

A constant for the [objectFit](SignBoard#objectFit) option

**Type**: object

|PROPERTY|TYPE|DESCRIPTION|
|:---:|:---:|:---:|
|FILL|string|"fill"|
|CONTAIN|string|"contain"|
|COVER|string|"cover"|
|NONE|string|"none"|
|SCALE_DOWN|string|"scale-down"|

```ts
import { OBJECT_FIT } from "signboard";
```

Loading

0 comments on commit a37762d

Please sign in to comment.