@lowdefy/docs 3.22.0-alpha.0 → 3.22.0-alpha.1

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.
Files changed (12) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/blocks/display/Title.yaml +4 -2
  3. package/blocks/input/CheckboxSwitch.yaml +56 -0
  4. package/concepts/cli.yaml +11 -3
  5. package/deployment/aws-lambda.yaml +1 -1
  6. package/deployment/docker.yaml +1 -1
  7. package/deployment/netlify.yaml +1 -1
  8. package/lowdefy.yaml +1 -1
  9. package/menus.yaml +3 -0
  10. package/operators/_get.yaml +15 -0
  11. package/package.json +2 -2
  12. package/pages.yaml +1 -0
package/CHANGELOG.md CHANGED
@@ -3,6 +3,27 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.22.0-alpha.1](https://github.com/lowdefy/lowdefy/compare/v3.22.0-alpha.0...v3.22.0-alpha.1) (2021-09-20)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **docs:** Added CheckboxSwitch examples and CheckboxSelector note. ([9cf56bf](https://github.com/lowdefy/lowdefy/commit/9cf56bfbaa5c7a75c55d24d2f965ec351c1672e0))
12
+ * **docs:** Added copyable and ellipsis config to Title block. ([9f8632e](https://github.com/lowdefy/lowdefy/commit/9f8632ec577196ea45471470a9dd13d3dbc09446))
13
+ * **docs:** Change npx commands to specific versions for deployments. ([f2c380b](https://github.com/lowdefy/lowdefy/commit/f2c380b07a78defff79281d5c07c61a718bfe750))
14
+ * **docs:** Convert CLI commands to npx commands. ([c9cd643](https://github.com/lowdefy/lowdefy/commit/c9cd643f3809fdc0cde7ba47e17e392b3236c17b))
15
+ * **docs:** Update CLI npm install docs. ([98a8b71](https://github.com/lowdefy/lowdefy/commit/98a8b71ff2ef961ccfcb8b94e115b4162881dd38))
16
+
17
+
18
+ ### Features
19
+
20
+ * **docs:** Add _get operator switch example. ([b727b9e](https://github.com/lowdefy/lowdefy/commit/b727b9edd0f37d3d10d5add32cbd9411fa4b6f98))
21
+ * **docs:** Added CheckboxSwitch docs. ([81752aa](https://github.com/lowdefy/lowdefy/commit/81752aa927f1d6050a290440ca15a87c05f3ea51))
22
+
23
+
24
+
25
+
26
+
6
27
  # [3.22.0-alpha.0](https://github.com/lowdefy/lowdefy/compare/v3.21.2...v3.22.0-alpha.0) (2021-09-08)
7
28
 
8
29
 
package/blocks/display/Title.yaml CHANGED
@@ -20,11 +20,13 @@ _ref:
20
20
  schema: ../blocks/blocksAntd/src/blocks/Title/Title.json
21
21
  filePath: blocks/display/Title.yaml
22
22
  init_state_values:
23
+ __type_block.properties.copyable: boolean
24
+ __type_block.properties.ellipsis: boolean
25
+ __boolean_block.properties.copyable: false
26
+ __boolean_block.properties.ellipsis: false
23
27
  __type_block.properties.value: number
24
28
  __number_block.properties.value: 33.3
25
29
  init_property_values:
26
30
  content: A title block.
27
31
  description_content: |
28
32
  A title component. Corresponds to html h1, h2, h3 and h4 elements.
29
-
30
-
package/blocks/input/CheckboxSwitch.yaml ADDED
@@ -0,0 +1,56 @@
1
+ # Copyright 2020-2021 Lowdefy, Inc
2
+
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ _ref:
16
+ path: templates/blocks/template.yaml.njk
17
+ vars:
18
+ block_type: CheckboxSwitch
19
+ value_type: any[]
20
+ category: input
21
+ schema: ../blocks/blocksAntd/src/blocks/CheckboxSwitch/CheckboxSwitch.json
22
+ filePath: blocks/input/CheckboxSwitch.yaml
23
+ description_content: |
24
+ The `CheckboxSwitch` block allows a user to select a boolean value between (true/false).
25
+
26
+ > A similar switch block is `Switch`. Alternatively the `CheckboxSelector` can be used to list multiple options.
27
+ examples:
28
+ - title: Checkbox only
29
+ block:
30
+ id: checkbox_example
31
+ type: CheckboxSwitch
32
+ properties:
33
+ label:
34
+ disabled: true
35
+ - title: Description only
36
+ block:
37
+ id: description_example
38
+ type: CheckboxSwitch
39
+ properties:
40
+ description: Option
41
+ - title: Description and label
42
+ block:
43
+ id: description_label_example
44
+ type: CheckboxSwitch
45
+ properties:
46
+ description: Option
47
+ label:
48
+ title: Label
49
+ - title: Agree to terms and conditions
50
+ block:
51
+ id: terms_example
52
+ type: CheckboxSwitch
53
+ properties:
54
+ description: I agree to the terms and conditions and privacy policy as found on the website.... Thoroughly I agree to the terms and conditions and privacy policy as found on the website....
55
+ label:
56
+ disabled: true
package/concepts/cli.yaml CHANGED
@@ -38,7 +38,15 @@ _ref:
38
38
  npx lowdefy@version <command>
39
39
  ```
40
40
 
41
- Alternative, you can install the CLI globally or to a npm project (with a `package.json` file) via npm. The CLI can then be used using `lowdefy` as the executable name:
41
+ Alternative, you can install the CLI globally or to a npm project (with a `package.json` file) via npm or yarn.
42
+
43
+ To install the CLI globally run:
44
+
45
+ ```
46
+ npm install lowdefy -g
47
+ ```
48
+
49
+ The CLI can then be run using `lowdefy` as the executable name:
42
50
 
43
51
  ```
44
52
  lowdefy <command>
@@ -90,12 +98,12 @@ _ref:
90
98
 
91
99
  Run the dev server, watching a relative directory for file changes:
92
100
  ```txt
93
- lowdefy dev --watch ../other-project
101
+ npx lowdefy@latest dev --watch ../other-project
94
102
  ```
95
103
 
96
104
  Run the dev server, ignoring the public directory:
97
105
  ```txt
98
- lowdefy dev --watch-ignore public/**
106
+ npx lowdefy@latest dev --watch-ignore public/**
99
107
  ```
100
108
 
101
109
  # Configuration
package/deployment/aws-lambda.yaml CHANGED
@@ -55,7 +55,7 @@ _ref:
55
55
  COPY --chown=node:node . .
56
56
 
57
57
  # Build the Lowdefy config using the Lowdefy CLI
58
- RUN npx lowdefy@latest build
58
+ RUN npx lowdefy@3.21.2 build
59
59
 
60
60
  # Use the correct Lowdefy base image
61
61
  FROM lowdefy/lowdefy-aws-lambda:3.21.2
package/deployment/docker.yaml CHANGED
@@ -65,7 +65,7 @@ _ref:
65
65
  COPY --chown=node:node . .
66
66
 
67
67
  # Build the Lowdefy config using the Lowdefy CLI
68
- RUN npx lowdefy@latest build
68
+ RUN npx lowdefy@3.21.2 build
69
69
 
70
70
  # Use the correct Lowdefy base image
71
71
  FROM lowdefy/lowdefy:3.21.2
package/deployment/netlify.yaml CHANGED
@@ -46,7 +46,7 @@ _ref:
46
46
 
47
47
  Configure your Netlify deployment.
48
48
 
49
- - Set your build command to `npx lowdefy@latest build-netlify`.
49
+ - Set your build command to `npx lowdefy@3 build-netlify`.
50
50
  - Set your publish directory to `.lowdefy/publish`.
51
51
 
52
52
  #### Step 4
package/lowdefy.yaml CHANGED
@@ -13,7 +13,7 @@
13
13
  # limitations under the License.
14
14
 
15
15
  name: '@lowdefy/docs'
16
- lowdefy: 3.22.0-alpha.0
16
+ lowdefy: 3.22.0-alpha.1
17
17
  licence: Apache-2.0
18
18
 
19
19
  cli:
package/menus.yaml CHANGED
@@ -201,6 +201,9 @@
201
201
  - id: CheckboxSelector
202
202
  type: MenuLink
203
203
  pageId: CheckboxSelector
204
+ - id: CheckboxSwitch
205
+ type: MenuLink
206
+ pageId: CheckboxSwitch
204
207
  - id: ChromeColorSelector
205
208
  type: MenuLink
206
209
  pageId: ChromeColorSelector
package/operators/_get.yaml CHANGED
@@ -47,6 +47,21 @@ _ref:
47
47
  ```
48
48
  Returns: `"George"`.
49
49
 
50
+ ###### Use _get to as a switch statement to choose an Icon name:
51
+ ```yaml
52
+ _get:
53
+ key:
54
+ _state: status
55
+ from:
56
+ new: PlusCircleTwoTone
57
+ escalated: ExclamationCircleOutlined
58
+ investigation_started: ToolTwoTone
59
+ client_contacted: SoundTwoTone
60
+ awaiting_confirmation: LikeOutlined
61
+ closed: StopOutlined
62
+ ```
63
+ Returns: The icon corresponding to the status in state.
64
+
50
65
  ###### Get from an array (arrays are `0` indexed):
51
66
  ```yaml
52
67
  _get:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lowdefy/docs",
3
- "version": "3.22.0-alpha.0",
3
+ "version": "3.22.0-alpha.1",
4
4
  "license": "Apache-2.0",
5
5
  "description": "",
6
6
  "homepage": "https://lowdefy.com",
@@ -40,5 +40,5 @@
40
40
  "publishConfig": {
41
41
  "access": "public"
42
42
  },
43
- "gitHead": "44ed43c7b245ba80a35af9e151cc9609c3ace595"
43
+ "gitHead": "182032a350f1a145fb7e8490834a1b549277dcee"
44
44
  }
package/pages.yaml CHANGED
@@ -41,6 +41,7 @@
41
41
  - _ref: blocks/input/AutoComplete.yaml
42
42
  - _ref: blocks/input/ButtonSelector.yaml
43
43
  - _ref: blocks/input/CheckboxSelector.yaml
44
+ - _ref: blocks/input/CheckboxSwitch.yaml
44
45
  - _ref: blocks/input/ChromeColorSelector.yaml
45
46
  - _ref: blocks/input/CircleColorSelector.yaml
46
47
  - _ref: blocks/input/ColorSelector.yaml