chayns-api 1.0.45 → 1.0.48
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/.babelrc +30 -30
- package/.eslintrc +17 -17
- package/.github/workflows/deploy_docs.yml +28 -28
- package/.github/workflows/publish.yml +21 -21
- package/LICENSE +21 -21
- package/README.md +54 -54
- package/dist/cjs/calls/dialogs/chaynsDialog.js +6 -3
- package/dist/cjs/calls/dialogs/date.js +12 -39
- package/dist/cjs/calls/dialogs/fileSelect.js +2 -1
- package/dist/cjs/calls/dialogs/input.js +3 -2
- package/dist/cjs/calls/dialogs/select.js +3 -2
- package/dist/cjs/calls/getUserInfo.js +2 -1
- package/dist/cjs/calls/index.js +121 -114
- package/dist/cjs/calls/sendMessage.js +8 -8
- package/dist/cjs/calls/visibilityChangeListener.js +4 -4
- package/dist/cjs/components/AppDialogWrapper.js +7 -5
- package/dist/cjs/components/ChaynsContext.js +4 -2
- package/dist/cjs/components/ChaynsProvider.js +5 -4
- package/dist/cjs/components/ErrorBoundary.js +31 -0
- package/dist/cjs/components/moduleWrapper.js +3 -2
- package/dist/cjs/components/withCompatMode.js +3 -3
- package/dist/cjs/hooks/geoLocationListener.js +4 -4
- package/dist/cjs/hooks/scrollListener.js +8 -8
- package/dist/cjs/hooks/useAccessToken.js +3 -2
- package/dist/cjs/hooks/useCurrentPage.js +2 -2
- package/dist/cjs/hooks/useCustomData.js +2 -2
- package/dist/cjs/hooks/useDevice.js +2 -2
- package/dist/cjs/hooks/useDialogState.js +6 -6
- package/dist/cjs/hooks/useEnvironment.js +2 -2
- package/dist/cjs/hooks/useFunctions.js +2 -2
- package/dist/cjs/hooks/useIsAdminMode.js +2 -2
- package/dist/cjs/hooks/useLanguage.js +2 -2
- package/dist/cjs/hooks/usePages.js +4 -4
- package/dist/cjs/hooks/useParameters.js +2 -2
- package/dist/cjs/hooks/useSite.js +2 -2
- package/dist/cjs/hooks/useUser.js +2 -2
- package/dist/cjs/hooks/useValues.js +2 -2
- package/dist/cjs/hooks/windowMetricsListener.js +4 -4
- package/dist/cjs/host/ChaynsHost.js +2 -1
- package/dist/cjs/host/iframe/HostIframe.js +5 -3
- package/dist/cjs/host/iframe/utils/useUpdateData.js +2 -1
- package/dist/cjs/host/module/ModuleHost.js +4 -3
- package/dist/cjs/host/module/utils/loadComponent.js +1 -1
- package/dist/cjs/host/module/utils/useDynamicScript.js +6 -4
- package/dist/cjs/index.js +5 -4
- package/dist/cjs/types/IChaynsReact.js +134 -114
- package/dist/cjs/util/appCall.js +4 -3
- package/dist/cjs/util/deviceHelper.js +5 -4
- package/dist/cjs/util/transferNestedFunctions.js +2 -2
- package/dist/cjs/wrapper/AppWrapper.js +3 -3
- package/dist/cjs/wrapper/FrameWrapper.js +2 -2
- package/dist/cjs/wrapper/StaticChaynsApi.js +2 -1
- package/dist/esm/calls/dialogs/date.js +34 -34
- package/dist/esm/calls/index.js +106 -106
- package/dist/esm/calls/sendMessage.js +8 -8
- package/dist/esm/calls/visibilityChangeListener.js +4 -4
- package/dist/esm/components/AppDialogWrapper.js +3 -2
- package/dist/esm/components/ChaynsProvider.js +1 -1
- package/dist/esm/components/ErrorBoundary.js +23 -0
- package/dist/esm/handler/DialogHandler.js +2 -2
- package/dist/esm/hooks/geoLocationListener.js +4 -4
- package/dist/esm/hooks/scrollListener.js +8 -8
- package/dist/esm/hooks/useAccessToken.js +3 -2
- package/dist/esm/hooks/useCurrentPage.js +2 -2
- package/dist/esm/hooks/useCustomData.js +2 -2
- package/dist/esm/hooks/useDevice.js +2 -2
- package/dist/esm/hooks/useDialogState.js +6 -6
- package/dist/esm/hooks/useEnvironment.js +2 -2
- package/dist/esm/hooks/useFunctions.js +2 -2
- package/dist/esm/hooks/useIsAdminMode.js +2 -2
- package/dist/esm/hooks/useLanguage.js +2 -2
- package/dist/esm/hooks/usePages.js +4 -4
- package/dist/esm/hooks/useParameters.js +2 -2
- package/dist/esm/hooks/useSite.js +2 -2
- package/dist/esm/hooks/useUser.js +2 -2
- package/dist/esm/hooks/useValues.js +2 -2
- package/dist/esm/hooks/windowMetricsListener.js +4 -4
- package/dist/esm/host/iframe/HostIframe.js +1 -0
- package/dist/esm/host/module/utils/loadComponent.js +1 -1
- package/dist/esm/types/IChaynsReact.js +108 -117
- package/dist/esm/util/appCall.js +2 -2
- package/dist/esm/util/deviceHelper.js +3 -3
- package/dist/esm/wrapper/AppWrapper.js +3 -3
- package/dist/esm/wrapper/FrameWrapper.js +2 -2
- package/dist/esm/wrapper/StaticChaynsApi.js +2 -2
- package/dist/types/calls/dialogs/alert.d.ts +1 -1
- package/dist/types/calls/dialogs/chaynsDialog.d.ts +24 -24
- package/dist/types/calls/dialogs/close.d.ts +1 -1
- package/dist/types/calls/dialogs/communication.d.ts +3 -3
- package/dist/types/calls/dialogs/confirm.d.ts +13 -13
- package/dist/types/calls/dialogs/date.d.ts +96 -96
- package/dist/types/calls/dialogs/dropUpAlert.d.ts +5 -5
- package/dist/types/calls/dialogs/fileSelect.d.ts +16 -16
- package/dist/types/calls/dialogs/iFrame.d.ts +10 -10
- package/dist/types/calls/dialogs/index.d.ts +14 -14
- package/dist/types/calls/dialogs/input.d.ts +15 -15
- package/dist/types/calls/dialogs/mediaSelect.d.ts +8 -8
- package/dist/types/calls/dialogs/open.d.ts +1 -1
- package/dist/types/calls/dialogs/select.d.ts +6 -6
- package/dist/types/calls/dialogs/signature.d.ts +7 -7
- package/dist/types/calls/dialogs/toast.d.ts +1 -1
- package/dist/types/calls/dialogs/utils/callback.d.ts +1 -1
- package/dist/types/calls/dialogs/utils/is.d.ts +4 -4
- package/dist/types/calls/getUserInfo.d.ts +9 -9
- package/dist/types/calls/index.d.ts +251 -251
- package/dist/types/calls/sendMessage.d.ts +13 -13
- package/dist/types/calls/visibilityChangeListener.d.ts +9 -9
- package/dist/types/components/AppDialogWrapper.d.ts +5 -5
- package/dist/types/components/ChaynsContext.d.ts +3 -3
- package/dist/types/components/ChaynsProvider.d.ts +11 -11
- package/dist/types/components/ErrorBoundary.d.ts +13 -0
- package/dist/types/components/WaitUntil.d.ts +7 -7
- package/dist/types/components/moduleWrapper.d.ts +4 -4
- package/dist/types/components/withCompatMode.d.ts +13 -13
- package/dist/types/handler/DialogHandler.d.ts +18 -18
- package/dist/types/helper/apiListenerHelper.d.ts +6 -6
- package/dist/types/hooks/geoLocationListener.d.ts +18 -18
- package/dist/types/hooks/index.d.ts +17 -17
- package/dist/types/hooks/scrollListener.d.ts +28 -28
- package/dist/types/hooks/useAccessToken.d.ts +6 -5
- package/dist/types/hooks/useCurrentPage.d.ts +4 -4
- package/dist/types/hooks/useCustomData.d.ts +4 -4
- package/dist/types/hooks/useDevice.d.ts +5 -5
- package/dist/types/hooks/useDialogState.d.ts +9 -9
- package/dist/types/hooks/useEnvironment.d.ts +5 -5
- package/dist/types/hooks/useFunctions.d.ts +5 -5
- package/dist/types/hooks/useIsAdminMode.d.ts +4 -4
- package/dist/types/hooks/useLanguage.d.ts +5 -5
- package/dist/types/hooks/usePages.d.ts +18 -18
- package/dist/types/hooks/useParameters.d.ts +5 -5
- package/dist/types/hooks/useSite.d.ts +5 -5
- package/dist/types/hooks/useUser.d.ts +5 -5
- package/dist/types/hooks/useValues.d.ts +5 -5
- package/dist/types/hooks/windowMetricsListener.d.ts +11 -11
- package/dist/types/host/ChaynsHost.d.ts +30 -30
- package/dist/types/host/iframe/HostIframe.d.ts +26 -26
- package/dist/types/host/iframe/utils/useUpdateData.d.ts +3 -3
- package/dist/types/host/module/ModuleHost.d.ts +27 -27
- package/dist/types/host/module/utils/loadComponent.d.ts +1 -1
- package/dist/types/host/module/utils/useDynamicScript.d.ts +9 -9
- package/dist/types/index.d.ts +19 -19
- package/dist/types/types/IChaynsReact.d.ts +809 -809
- package/dist/types/types/dialog.d.ts +41 -41
- package/dist/types/util/appCall.d.ts +2 -2
- package/dist/types/util/deviceHelper.d.ts +7 -7
- package/dist/types/util/heightHelper.d.ts +1 -1
- package/dist/types/util/postIframeForm.d.ts +1 -1
- package/dist/types/util/transferNestedFunctions.d.ts +1 -1
- package/dist/types/util/url.d.ts +1 -1
- package/dist/types/wrapper/AppWrapper.d.ts +22 -22
- package/dist/types/wrapper/FrameWrapper.d.ts +15 -15
- package/dist/types/wrapper/ModuleFederationWrapper.d.ts +10 -10
- package/dist/types/wrapper/SsrWrapper.d.ts +11 -11
- package/dist/types/wrapper/StaticChaynsApi.d.ts +9 -9
- package/package.json +78 -78
- package/toolkit.config.js +20 -20
- package/tsconfig.json +56 -56
package/.babelrc
CHANGED
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
{
|
|
2
|
-
"env": {
|
|
3
|
-
"esm": {
|
|
4
|
-
"presets": [
|
|
5
|
-
[
|
|
6
|
-
"@babel/preset-env",
|
|
7
|
-
{
|
|
8
|
-
"targets": ">0.5%, not dead, not op_mini all, chrome 71",
|
|
9
|
-
"modules": false
|
|
10
|
-
}
|
|
11
|
-
],
|
|
12
|
-
"@babel/preset-react",
|
|
13
|
-
"@babel/preset-typescript"
|
|
14
|
-
]
|
|
15
|
-
},
|
|
16
|
-
"cjs": {
|
|
17
|
-
"presets": [
|
|
18
|
-
[
|
|
19
|
-
"@babel/preset-env",
|
|
20
|
-
{
|
|
21
|
-
"targets": { "node": 12 },
|
|
22
|
-
"modules": "commonjs"
|
|
23
|
-
}
|
|
24
|
-
],
|
|
25
|
-
"@babel/preset-react",
|
|
26
|
-
"@babel/preset-typescript"
|
|
27
|
-
]
|
|
28
|
-
}
|
|
29
|
-
}
|
|
30
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"env": {
|
|
3
|
+
"esm": {
|
|
4
|
+
"presets": [
|
|
5
|
+
[
|
|
6
|
+
"@babel/preset-env",
|
|
7
|
+
{
|
|
8
|
+
"targets": ">0.5%, not dead, not op_mini all, chrome 71",
|
|
9
|
+
"modules": false
|
|
10
|
+
}
|
|
11
|
+
],
|
|
12
|
+
"@babel/preset-react",
|
|
13
|
+
"@babel/preset-typescript"
|
|
14
|
+
]
|
|
15
|
+
},
|
|
16
|
+
"cjs": {
|
|
17
|
+
"presets": [
|
|
18
|
+
[
|
|
19
|
+
"@babel/preset-env",
|
|
20
|
+
{
|
|
21
|
+
"targets": { "node": 12 },
|
|
22
|
+
"modules": "commonjs"
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"@babel/preset-react",
|
|
26
|
+
"@babel/preset-typescript"
|
|
27
|
+
]
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
package/.eslintrc
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
{
|
|
2
|
-
"extends": "@chayns-toolkit",
|
|
3
|
-
"rules": {
|
|
4
|
-
"no-void": "off",
|
|
5
|
-
"react/function-component-definition": [
|
|
6
|
-
"error",
|
|
7
|
-
{
|
|
8
|
-
"namedComponents": "arrow-function",
|
|
9
|
-
"unnamedComponents": "arrow-function"
|
|
10
|
-
}
|
|
11
|
-
],
|
|
12
|
-
"@typescript-eslint/require-await": "off",
|
|
13
|
-
"@typescript-eslint/no-explicit-any": "off",
|
|
14
|
-
"class-methods-use-this": "off",
|
|
15
|
-
"react/jsx-props-no-spreading": "off"
|
|
16
|
-
}
|
|
17
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"extends": "@chayns-toolkit",
|
|
3
|
+
"rules": {
|
|
4
|
+
"no-void": "off",
|
|
5
|
+
"react/function-component-definition": [
|
|
6
|
+
"error",
|
|
7
|
+
{
|
|
8
|
+
"namedComponents": "arrow-function",
|
|
9
|
+
"unnamedComponents": "arrow-function"
|
|
10
|
+
}
|
|
11
|
+
],
|
|
12
|
+
"@typescript-eslint/require-await": "off",
|
|
13
|
+
"@typescript-eslint/no-explicit-any": "off",
|
|
14
|
+
"class-methods-use-this": "off",
|
|
15
|
+
"react/jsx-props-no-spreading": "off"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
name: Deploy Docs to GitHub Pages
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
push:
|
|
5
|
-
paths:
|
|
6
|
-
- "website/**"
|
|
7
|
-
workflow_dispatch:
|
|
8
|
-
|
|
9
|
-
jobs:
|
|
10
|
-
deploy:
|
|
11
|
-
runs-on: ubuntu-20.04
|
|
12
|
-
steps:
|
|
13
|
-
- name: Checkout repo
|
|
14
|
-
uses: actions/checkout@v2
|
|
15
|
-
|
|
16
|
-
- name: Use Node 16
|
|
17
|
-
uses: actions/setup-node@v1
|
|
18
|
-
with:
|
|
19
|
-
node-version: 16
|
|
20
|
-
|
|
21
|
-
- name: Build
|
|
22
|
-
run: npm run build-docs
|
|
23
|
-
|
|
24
|
-
- name: Deploy to GitHub Pages
|
|
25
|
-
uses: peaceiris/actions-gh-pages@v3
|
|
26
|
-
with:
|
|
27
|
-
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
28
|
-
publish_dir: ./website/build
|
|
1
|
+
name: Deploy Docs to GitHub Pages
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
paths:
|
|
6
|
+
- "website/**"
|
|
7
|
+
workflow_dispatch:
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
deploy:
|
|
11
|
+
runs-on: ubuntu-20.04
|
|
12
|
+
steps:
|
|
13
|
+
- name: Checkout repo
|
|
14
|
+
uses: actions/checkout@v2
|
|
15
|
+
|
|
16
|
+
- name: Use Node 16
|
|
17
|
+
uses: actions/setup-node@v1
|
|
18
|
+
with:
|
|
19
|
+
node-version: 16
|
|
20
|
+
|
|
21
|
+
- name: Build
|
|
22
|
+
run: npm run build-docs
|
|
23
|
+
|
|
24
|
+
- name: Deploy to GitHub Pages
|
|
25
|
+
uses: peaceiris/actions-gh-pages@v3
|
|
26
|
+
with:
|
|
27
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
28
|
+
publish_dir: ./website/build
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
name: Publish to NPM
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
workflow_dispatch:
|
|
5
|
-
push:
|
|
6
|
-
tags:
|
|
7
|
-
- 'v*'
|
|
8
|
-
|
|
9
|
-
jobs:
|
|
10
|
-
build:
|
|
11
|
-
runs-on: ubuntu-latest
|
|
12
|
-
steps:
|
|
13
|
-
- uses: actions/checkout@v2
|
|
14
|
-
- uses: actions/setup-node@v1
|
|
15
|
-
with:
|
|
16
|
-
node-version: '14.21.1'
|
|
17
|
-
registry-url: https://registry.npmjs.org/
|
|
18
|
-
- run: npm install
|
|
19
|
-
- run: npm publish
|
|
20
|
-
env:
|
|
21
|
-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
1
|
+
name: Publish to NPM
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
push:
|
|
6
|
+
tags:
|
|
7
|
+
- 'v*'
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
build:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v2
|
|
14
|
+
- uses: actions/setup-node@v1
|
|
15
|
+
with:
|
|
16
|
+
node-version: '14.21.1'
|
|
17
|
+
registry-url: https://registry.npmjs.org/
|
|
18
|
+
- run: npm install
|
|
19
|
+
- run: npm publish
|
|
20
|
+
env:
|
|
21
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2022 Tobit.Software
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Tobit.Software
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,54 +1,54 @@
|
|
|
1
|
-
# [chayns react api](https://github.com/TobitSoftware/chayns-api) · []() []() []()
|
|
2
|
-
|
|
3
|
-
The chayns-api provides information and useful functions to your page. The information and functions are provided by react hooks and normal functions.
|
|
4
|
-
A list of all functions and hooks can be found [here](https://tobitsoftware.github.io/chayns-api/docs).
|
|
5
|
-
|
|
6
|
-
## Installation
|
|
7
|
-
|
|
8
|
-
It is recommended to setup your new chayns page with the [create-chayns-app](https://github.com/TobitSoftware/create-chayns-app).
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
### Migrate old project
|
|
12
|
-
1. Install chayns-api package
|
|
13
|
-
```sh
|
|
14
|
-
# NPM
|
|
15
|
-
$ npm install chayns-api
|
|
16
|
-
|
|
17
|
-
# Yarn
|
|
18
|
-
$ yarn add chayns-api
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
2. Wrap your App component with the "ChaynsProvider" component. In all components which are under the ChaynsProvider you can use hooks and chayns functions.
|
|
22
|
-
```jsx
|
|
23
|
-
<ChaynsProvider>
|
|
24
|
-
<App/>
|
|
25
|
-
</ChaynsProvider>
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
## Example
|
|
29
|
-
|
|
30
|
-
```jsx
|
|
31
|
-
import { useUser } from 'chayns-api';
|
|
32
|
-
|
|
33
|
-
const FirstName = () => {
|
|
34
|
-
const user = useUser();
|
|
35
|
-
|
|
36
|
-
return (
|
|
37
|
-
<div>{user?.firstName}</div>
|
|
38
|
-
);
|
|
39
|
-
}
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
## Getting started
|
|
43
|
-
|
|
44
|
-
More information to setup chayns-api can be found in the [documentation](https://tobitsoftware.github.io/chayns-api/docs).
|
|
45
|
-
|
|
46
|
-
## Troubleshooting
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
Can't resolve 'react-dom/client'
|
|
50
|
-
```
|
|
51
|
-
A warning like above can be shown when you are still using react 17.
|
|
52
|
-
This can be ignored because the react 17 api is used as fallback instead.
|
|
53
|
-
|
|
54
|
-
## License
|
|
1
|
+
# [chayns react api](https://github.com/TobitSoftware/chayns-api) · []() []() []()
|
|
2
|
+
|
|
3
|
+
The chayns-api provides information and useful functions to your page. The information and functions are provided by react hooks and normal functions.
|
|
4
|
+
A list of all functions and hooks can be found [here](https://tobitsoftware.github.io/chayns-api/docs).
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
It is recommended to setup your new chayns page with the [create-chayns-app](https://github.com/TobitSoftware/create-chayns-app).
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Migrate old project
|
|
12
|
+
1. Install chayns-api package
|
|
13
|
+
```sh
|
|
14
|
+
# NPM
|
|
15
|
+
$ npm install chayns-api
|
|
16
|
+
|
|
17
|
+
# Yarn
|
|
18
|
+
$ yarn add chayns-api
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
2. Wrap your App component with the "ChaynsProvider" component. In all components which are under the ChaynsProvider you can use hooks and chayns functions.
|
|
22
|
+
```jsx
|
|
23
|
+
<ChaynsProvider>
|
|
24
|
+
<App/>
|
|
25
|
+
</ChaynsProvider>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```jsx
|
|
31
|
+
import { useUser } from 'chayns-api';
|
|
32
|
+
|
|
33
|
+
const FirstName = () => {
|
|
34
|
+
const user = useUser();
|
|
35
|
+
|
|
36
|
+
return (
|
|
37
|
+
<div>{user?.firstName}</div>
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Getting started
|
|
43
|
+
|
|
44
|
+
More information to setup chayns-api can be found in the [documentation](https://tobitsoftware.github.io/chayns-api/docs).
|
|
45
|
+
|
|
46
|
+
## Troubleshooting
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
Can't resolve 'react-dom/client'
|
|
50
|
+
```
|
|
51
|
+
A warning like above can be shown when you are still using react 17.
|
|
52
|
+
This can be ignored because the react 17 api is used as fallback instead.
|
|
53
|
+
|
|
54
|
+
## License
|
|
@@ -8,7 +8,7 @@ exports.chaynsDialog = chaynsDialog;
|
|
|
8
8
|
exports.dialogAction = void 0;
|
|
9
9
|
var _open = require("./open");
|
|
10
10
|
var _callback = require("./utils/callback");
|
|
11
|
-
const buttonText =
|
|
11
|
+
const buttonText = {
|
|
12
12
|
'YES': {
|
|
13
13
|
'de': 'Ja',
|
|
14
14
|
'en': 'Yes',
|
|
@@ -27,12 +27,14 @@ const buttonText = exports.buttonText = {
|
|
|
27
27
|
'nl': 'Annuleren'
|
|
28
28
|
}['de'] || 'Cancel'
|
|
29
29
|
};
|
|
30
|
-
|
|
30
|
+
exports.buttonText = buttonText;
|
|
31
|
+
const buttonType = {
|
|
31
32
|
'CANCEL': -1,
|
|
32
33
|
'NEGATIVE': 0,
|
|
33
34
|
'POSITIVE': 1
|
|
34
35
|
};
|
|
35
|
-
|
|
36
|
+
exports.buttonType = buttonType;
|
|
37
|
+
const dialogAction = {
|
|
36
38
|
'ALERT_CONFIRM': 178,
|
|
37
39
|
'INPUT': 173,
|
|
38
40
|
'SELECT': 174,
|
|
@@ -44,6 +46,7 @@ const dialogAction = exports.dialogAction = {
|
|
|
44
46
|
'SIGNATURE': 181,
|
|
45
47
|
'IFRAME': 191
|
|
46
48
|
};
|
|
49
|
+
exports.dialogAction = dialogAction;
|
|
47
50
|
function chaynsDialog(config) {
|
|
48
51
|
const callbackName = 'chaynsDialog';
|
|
49
52
|
config.callback = (0, _callback.getCallbackName)(callbackName);
|
|
@@ -10,34 +10,6 @@ var _chaynsDialog = require("./chaynsDialog");
|
|
|
10
10
|
var _is = require("./utils/is");
|
|
11
11
|
var _open = require("./open");
|
|
12
12
|
var _index = require("../index");
|
|
13
|
-
/**
|
|
14
|
-
* The config object for date dialog
|
|
15
|
-
* @typedef {Object} dateConfig
|
|
16
|
-
* @property {Date} preSelect - The date object which should be preselected.
|
|
17
|
-
* @property {Date} minDate - The min date which you could select.
|
|
18
|
-
* @property {Date} maxDate - The max date which you could select.
|
|
19
|
-
* @property {dateDialogType} dateType - The type of dialog you want to display.
|
|
20
|
-
* @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
|
|
21
|
-
* @property {string} message - The message that is displayed above the date dialog, only in apps supported
|
|
22
|
-
* @property {string} title - The title that is displayed above the message, only in apps supported
|
|
23
|
-
*/
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* This call will open a date select dialog.
|
|
27
|
-
* <div>Call: 30</div>
|
|
28
|
-
* @param {dateConfig} config - Define the configuration of this call
|
|
29
|
-
* @return {Promise} contains a timestamp as result
|
|
30
|
-
* @example chayns.dialog.date({
|
|
31
|
-
* 'dateType': chayns.dialog.dateType.DATE_TIME,
|
|
32
|
-
* 'preSelect': new Date(2018, 6, 14, 0, 0, 0),
|
|
33
|
-
* 'minDate': new Date(2018, 6, 1, 15, 0, 0),
|
|
34
|
-
* 'maxDate': new Date(2019, 6, 1, 0, 23, 0),
|
|
35
|
-
* 'minuteInterval': 15
|
|
36
|
-
* ).then(function (data) {
|
|
37
|
-
* console.log(data);
|
|
38
|
-
* });
|
|
39
|
-
*/
|
|
40
|
-
|
|
41
13
|
function date(config = {}) {
|
|
42
14
|
let {
|
|
43
15
|
preSelect,
|
|
@@ -170,24 +142,25 @@ function advancedDate(config = {}) {
|
|
|
170
142
|
});
|
|
171
143
|
}
|
|
172
144
|
|
|
173
|
-
/**
|
|
174
|
-
* @typedef {number} dateDialogType
|
|
145
|
+
/**
|
|
146
|
+
* @typedef {number} dateDialogType
|
|
175
147
|
*/
|
|
176
148
|
|
|
177
|
-
/**
|
|
178
|
-
* Enum for date dialog
|
|
179
|
-
* <div>DATE will open a dialog where you can select a special day</div>
|
|
180
|
-
* <div>TIME will open a dialog where you can only select a special time</div>
|
|
181
|
-
* <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
|
|
182
|
-
* @readonly
|
|
183
|
-
* @enum {dateDialogType}
|
|
184
|
-
* @type {{DATE: number, TIME: number, DATE_TIME: number}}
|
|
149
|
+
/**
|
|
150
|
+
* Enum for date dialog
|
|
151
|
+
* <div>DATE will open a dialog where you can select a special day</div>
|
|
152
|
+
* <div>TIME will open a dialog where you can only select a special time</div>
|
|
153
|
+
* <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
|
|
154
|
+
* @readonly
|
|
155
|
+
* @enum {dateDialogType}
|
|
156
|
+
* @type {{DATE: number, TIME: number, DATE_TIME: number}}
|
|
185
157
|
*/
|
|
186
|
-
const dateType =
|
|
158
|
+
const dateType = {
|
|
187
159
|
'DATE': 1,
|
|
188
160
|
'TIME': 2,
|
|
189
161
|
'DATE_TIME': 3
|
|
190
162
|
};
|
|
163
|
+
exports.dateType = dateType;
|
|
191
164
|
function validateValue(value) {
|
|
192
165
|
if (!(0, _is.isNumber)(value)) {
|
|
193
166
|
if ((0, _is.isDate)(value)) {
|
|
@@ -8,12 +8,13 @@ exports.fileType = void 0;
|
|
|
8
8
|
var _chaynsDialog = require("./chaynsDialog");
|
|
9
9
|
var _open = require("./open");
|
|
10
10
|
var _index = require("../index");
|
|
11
|
-
const fileType =
|
|
11
|
+
const fileType = {
|
|
12
12
|
'IMAGE': 'image',
|
|
13
13
|
'VIDEO': 'video',
|
|
14
14
|
'AUDIO': 'audio',
|
|
15
15
|
'DOCUMENT': ['application/x-latex', 'application/x-tex', 'text/', 'application/json', 'application/pdf', 'application/msword', 'application/msexcel', 'application/mspowerpoint', 'application/vnd.ms-word', 'application/vnd.ms-excel', 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument', 'application/vnd.oasis.opendocument']
|
|
16
16
|
};
|
|
17
|
+
exports.fileType = fileType;
|
|
17
18
|
async function fileSelect(dialog = {}) {
|
|
18
19
|
if (!dialog.buttons || !Array.isArray(dialog.buttons)) {
|
|
19
20
|
dialog.buttons = [];
|
|
@@ -23,10 +23,11 @@ function input(dialog = {}) {
|
|
|
23
23
|
dialog.callType = _chaynsDialog.dialogAction.INPUT;
|
|
24
24
|
return (0, _open.open)(dialog);
|
|
25
25
|
}
|
|
26
|
-
const inputType =
|
|
26
|
+
const inputType = {
|
|
27
27
|
'DEFAULT': 0,
|
|
28
28
|
'PASSWORD': 1,
|
|
29
29
|
'TEXTAREA': 2,
|
|
30
30
|
'INPUT': 3,
|
|
31
31
|
'NUMBER': 4
|
|
32
|
-
};
|
|
32
|
+
};
|
|
33
|
+
exports.inputType = inputType;
|