@lowdefy/docs 4.0.0-alpha.7 → 4.0.0-alpha.8

package/blocks/display/MarkdownWithCode.yaml

@@ -1,46 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: MarkdownWithCode
-    category: display
-    schema: ../plugins/blocks/blocks-markdown/src/blocks/MarkdownWithCode/schema.json
-    filePath: blocks/display/MarkdownWithCode.yaml
-    init_property_values:
-      content: |
-        ### Some JS Math:
-        ```js
-          true + true; // -> 2
-          (true + true) * (true + true) - true; // -> 3
-        ```
-        Hmmm… 🤔
-
-        Fine the explanation [here](https://github.com/denysdovhan/wtfjs#math-with-true-and-false)
-
-    description_content: |
-      Render markdown content with code highlighting support. Currently, the following languages are supported:
-      - HTML: `html`
-      - Java: `java`
-      - Javascript: `javascript`, `js`, `jsx`
-      - JSON: `json`
-      - Markdown: `markdown`
-      - Nunjucks: `nunjucks`
-      - Python: `python`, `py`,
-      - Typescript: `typescript`, `ts`,
-      - XML: `xml`
-      - YAML: `yaml`
-
-      > For more details on markdown syntax see: [Markdown cheat sheet](https://guides.github.com/features/mastering-markdown/).

package/blocks/display/Menu.yaml

@@ -1,48 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Menu
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Menu/schema.json
-    filePath: blocks/display/Menu.yaml
-    description_content: |
-      A menu block used to display page links.
-    init_state_values:
-      block.properties.links:
-        - id: home
-          type: MenuLink
-          pageId: home
-          properties:
-            icon: AiOutlinedHome
-            title: Home
-        - id: pages
-          type: MenuGroup
-          properties:
-            title: Pages
-            icon: AiOutlinedLayout
-          links:
-            - id: page1
-              type: MenuLink
-              pageId: page1
-              properties:
-                title: Page 1
-            - id: more_pages
-              type: MenuGroup
-              links:
-                - id: page3
-                  type: MenuLink
-                  pageId: page3

package/blocks/display/Message.yaml

@@ -1,34 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Message
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Message/schema.json
-    filePath: blocks/display/Message.yaml
-    description_content: |
-      Display a popup message on the page.
-
-      > To display a message, invoke the open method.
-
-    methods:
-      - name: open
-        onClick:
-          - id: open
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: open

package/blocks/display/MobileMenu.yaml

@@ -1,47 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: MobileMenu
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/MobileMenu/schema.json
-    description_content: |
-      A menu designed for mobile devices. Renders a button that opens a Drawer with the menu inside. This menu is used by default in `PageHeaderMenu` and `PageSiderMenu` on mobile devices.
-    init_state_values:
-      block.properties.links:
-        - id: home
-          type: MenuLink
-          pageId: home
-          properties:
-            icon: AiOutlinedHome
-            title: Home
-        - id: pages
-          type: MenuGroup
-          properties:
-            title: Pages
-            icon: AiOutlinedLayout
-          links:
-            - id: page1
-              type: MenuLink
-              pageId: page1
-              properties:
-                title: Page 1
-            - id: more_pages
-              type: MenuGroup
-              links:
-                - id: page3
-                  type: MenuLink
-                  pageId: page3

package/blocks/display/Notification.yaml

@@ -1,34 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Notification
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Notification/schema.json
-    filePath: blocks/display/Notification.yaml
-    description_content: |
-      Display a popup notification on the page.
-
-      > To display a notification, invoke the open method.
-
-    methods:
-      - name: open
-        onClick:
-          - id: open
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: open

package/blocks/display/Paragraph.yaml

@@ -1,30 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Paragraph
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Paragraph/schema.json
-    filePath: blocks/display/Paragraph.yaml
-    init_state_values:
-      __type_block.properties.copyable: boolean
-      __type_block.properties.ellipsis: boolean
-      __boolean_block.properties.copyable: false
-      __boolean_block.properties.ellipsis: false
-    init_property_values:
-      content: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.'
-    description_content: |
-      A paragraph text component.

package/blocks/display/Progress.yaml

@@ -1,52 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Progress
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Progress/schema.json
-    filePath: blocks/display/Progress.yaml
-    init_property_values:
-      percent: 30
-    description_content: |
-      Display the current progress as a percentage of completion.
-
-    examples:
-      - title: Line progress
-        block:
-          id: line_example
-          type: Progress
-          properties:
-            type: line
-            percent: 60
-            strokeColor: '#fcb900'
-            status: active
-      - title: Circle progress
-        block:
-          id: circle_example
-          type: Progress
-          properties:
-            type: circle
-            percent: 60
-            strokeColor: '#52c41a'
-      - title: Dashboard progress
-        block:
-          id: dashboard_example
-          type: Progress
-          properties:
-            type: dashboard
-            percent: 60
-            strokeColor: '#1890ff'

package/blocks/display/Skeleton.yaml

@@ -1,27 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Skeleton
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Skeleton/schema.json
-    filePath: blocks/display/Skeleton.yaml
-    description_content: |
-      Skeleton block to use as a loading place holder.
-
-    examples:
-      - title: Basic skeleton
-        properties: '{}'

package/blocks/display/Statistic.yaml

@@ -1,35 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Statistic
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Statistic/schema.json
-    filePath: blocks/display/Statistic.yaml
-    init_state_values:
-      __type_block.properties.value: number
-      __number_block.properties.value: 33.3
-    description_content: |
-      A statistic block renders indicator numbers.
-
-    examples:
-      - title: Basic statistic
-        block:
-          id: basic_example
-          type: Statistic
-          properties:
-            value: 99.5
-            prefixIcon: AiTwoToneAlert

package/blocks/display/Title.yaml

@@ -1,32 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Title
-    category: display
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Title/schema.json
-    filePath: blocks/display/Title.yaml
-    init_state_values:
-      __type_block.properties.copyable: boolean
-      __type_block.properties.ellipsis: boolean
-      __boolean_block.properties.copyable: false
-      __boolean_block.properties.ellipsis: false
-      __type_block.properties.value: number
-      __number_block.properties.value: 33.3
-    init_property_values:
-      content: A title block.
-    description_content: |
-      A title component. Corresponds to html h1, h2, h3 and h4 elements.

package/blocks/input/AutoComplete.yaml

@@ -1,30 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: AutoComplete
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/AutoComplete/schema.json
-    filePath: blocks/input/AutoComplete.yaml
-    init_property_values:
-      options:
-        - one
-        - two
-    description_content: |
-      The AutoComplete block is a text input that has a list of suggestions for the user. These suggestions are filtered as the user fills in the input. The user is also allowed to fill in an input not part of that list.
-
-      >If you need the user to select only from a list of options, use a block like the `Selector` block instead.

package/blocks/input/ButtonSelector.yaml

@@ -1,36 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: ButtonSelector
-    value_type: any
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/ButtonSelector/schema.json
-    filePath: blocks/input/ButtonSelector.yaml
-    init_state_values:
-      __type_block.properties.options: object[]
-      __object_arr_block.properties.options:
-        - label: First
-          value: '1'
-        - label: Second
-          value: '2'
-
-    description_content: |
-      The `ButtonSelector` block allows a user to select a single value from a set of options. The user cannot deselect an option once they have selected an input.
-
-      The options for the selector can be provides as either an array of primitive values (strings, numbers, booleans or dates), or as an array of label-value pairs, where the label is a string, and the value can be of any type, including objects like dates and arrays.
-
-      > Other selector blocks are `CheckboxSelector`, `MultipleSelector`, `RadioSelector` and `Selector`.

package/blocks/input/CheckboxSelector.yaml

@@ -1,36 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: CheckboxSelector
-    value_type: any[]
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/CheckboxSelector/schema.json
-    filePath: blocks/input/CheckboxSelector.yaml
-    init_state_values:
-      __type_block.properties.options: object[]
-      __object_arr_block.properties.options:
-        - label: First
-          value: '1'
-        - label: Second
-          value: '2'
-
-    description_content: |
-      The `CheckboxSelector` block allows a user to select multiple values from a set of options.
-
-      The options for the selector can be provides as either an array of primitive values (strings, numbers, booleans, or dates), or as an array of label-value pairs, where the label is a string, and the value can be of any type, including objects like dates and arrays.
-
-      > Other selector blocks are `ButtonSelector`, `MultipleSelector`, `RadioSelector` and `Selector`.

package/blocks/input/CheckboxSwitch.yaml

@@ -1,56 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: CheckboxSwitch
-    value_type: any[]
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/CheckboxSwitch/schema.json
-    filePath: blocks/input/CheckboxSwitch.yaml
-    description_content: |
-      The `CheckboxSwitch` block allows a user to select a boolean value between (true/false).
-
-      > A similar switch block is `Switch`. Alternatively the `CheckboxSelector` can be used to list multiple options.
-    examples:
-      - title: Checkbox only
-        block:
-          id: checkbox_example
-          type: CheckboxSwitch
-          properties:
-            label:
-              disabled: true
-      - title: Description only
-        block:
-          id: description_example
-          type: CheckboxSwitch
-          properties:
-            description: Option
-      - title: Description and label
-        block:
-          id: description_label_example
-          type: CheckboxSwitch
-          properties:
-            description: Option
-            label:
-              title: Label
-      - title: Agree to terms and conditions
-        block:
-          id: terms_example
-          type: CheckboxSwitch
-          properties:
-            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....
-            label:
-              disabled: true

package/blocks/input/ChromeColorSelector.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: ChromeColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/ChromeColorSelector/schema.json
-    filePath: blocks/input/ChromeColorSelector.yaml
-    description_content: |
-      A color selector component similar to the chrome developer tools color selector.

package/blocks/input/CircleColorSelector.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: CircleColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/CircleColorSelector/schema.json
-    filePath: blocks/input/CircleColorSelector.yaml
-    description_content: |
-      A color selector component which displays the colors in circles.

package/blocks/input/ColorSelector.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: ColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/ColorSelector/schema.json
-    filePath: blocks/input/ColorSelector.yaml
-    description_content: |
-      A color selector component.

package/blocks/input/CompactColorSelector.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: CompactColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/CompactColorSelector/schema.json
-    filePath: blocks/input/CompactColorSelector.yaml
-    description_content: |
-      A compact color selector component.