@lowdefy/docs 3.23.2 → 4.0.0-alpha.10

package/blocks/container/Affix.yaml

@@ -1,26 +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: Affix
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Affix/Affix.json
-    filePath: blocks/container/Affix.yaml
-    description_content: |
-      An Affix block makes it's content stick to the viewport.
-      The Affix has a single area, `content`.
-    areas:
-      - content

package/blocks/container/Badge.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: Badge
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Badge/Badge.json
-    filePath: blocks/container/Badge.yaml
-    description_content: |
-      Small numerical value or status descriptor for UI elements. Badge is used as a container block, describing its content block.
-    init_property_values:
-      count: 1
-    areas:
-      - content

package/blocks/container/Box.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: Box
-    category: container
-    schema: ../blocks/blocksBasic/src/blocks/Box/Box.json
-    filePath: blocks/container/Box.yaml
-    description_content: |
-      A Box is a container that places sub-blocks into a html `<div>`.
-      The Box has a single area, `content`.
-
-    areas:
-      - content

package/blocks/container/Card.yaml

@@ -1,29 +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: Card
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Card/Card.json
-    filePath: blocks/container/Card.yaml
-    description_content: |
-      A Card container places blocks on a white background with a card border.
-      The Card has `content`, `title` and `extra` areas. The `title` area replaces `properties.title` if defined.
-
-    areas:
-      - content
-      - extra
-      - title

package/blocks/container/Collapse.yaml

@@ -1,38 +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: Collapse
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Collapse/Collapse.json
-    description_content: |
-      A container with collapsible panels. The area keys are user defined, and should be listed under the `panels` property. Each panel also has a 'extra' content area, the key of which can be defined in the `panels.$.extraKey` property.
-    init_state_values:
-      block.properties.panels:
-        - key: panel1
-          extraKey: panel1Extra
-          title: Panel 1
-        - key: panel2
-          title: Panel 2
-        - key: panel3
-          disabled: true
-          title: Panel 3
-    user_defined_areas: true
-    areas:
-      - panel1
-      - panel1Extra
-      - panel2
-      - panel3

package/blocks/container/Comment.yaml

@@ -1,43 +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: Comment
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Comment/Comment.json
-    filePath: blocks/container/Comment.yaml
-    init_state_values:
-      __type_block.properties.avatar: object
-    description_content: |
-      A Comment renders a comment list item. It can be used as both a `display` or `container` category block.
-    areas:
-      - content
-      - actions
-      - author
-      - title
-    examples:
-      - title: Comment
-        block:
-          id: comment_ex
-          type: Comment
-          properties: 
-            author: The Dude
-            content: Yeah, well, you know, that’s just, like, your opinion, man.
-            datetime: 18 January, 1998
-            avatar: 
-              color: "#402B18"
-              content: TD
-              shape: square

package/blocks/container/ConfirmModal.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: ConfirmModal
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/ConfirmModal/ConfirmModal.json
-    filePath: blocks/container/ConfirmModal.yaml
-    description_content: |
-      A popup container, presenting the user with a modal confirmation dialog.
-      The ConfirmModal has a single area, `content`.
-
-      > To open the confirm modal, invoke the open method.
-    areas:
-      - content
-    methods:
-      - name: open
-        onClick:
-          - id: open
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: open

package/blocks/container/Drawer.yaml

@@ -1,45 +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: Drawer
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Drawer/Drawer.json
-    filePath: blocks/container/Drawer.yaml
-    description_content: |
-      A panel which slides in from the edge of the screen.
-      The Drawer has a single area, `content`.
-
-      > To open the drawer, invoke a drawer method.
-    areas:
-      - content
-    methods:
-      - name: toggleOpen
-        onClick:
-          - id: toggleOpen
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: toggleOpen
-      - name: setOpen
-        onClick:
-          - id: setOpen
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: setOpen
-              args:
-                - open: true

package/blocks/container/Label.yaml

@@ -1,29 +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: Label
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Label/Label.json
-    filePath: blocks/container/Label.yaml
-    description_content: |
-      A container that provides a label for a input block. Most input block use Label by default.
-    init_property_values:
-      title: Input title
-    areas:
-      - content
-      # - label
-

package/blocks/container/Modal.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: Modal
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Modal/Modal.json
-    filePath: blocks/container/Modal.yaml
-    description_content: |
-      A popup container, presenting the user with a modal dialog.
-      The Modal has a `content` and a `footer` content area. The default `footer` area is the `Ok` and `Cancel` buttons; defining a `footer` area overwrites these buttons.
-
-      > To open the modal, invoke a modal method.
-    areas:
-      - content
-      - footer
-    methods:
-      - name: toggleOpen
-        onClick:
-          - id: toggleOpen
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: toggleOpen
-      - name: setOpen
-        onClick:
-          - id: setOpen
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: setOpen
-              args:
-                - open: true

package/blocks/container/Result.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: Result
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Result/Result.json
-    filePath: blocks/container/Result.yaml
-    description_content: |
-      Used to provide feedback the results of a task or error.
-    areas:
-      - content
-      - extra
-    examples:
-      - title: 500 Error
-        block:
-          id: error_example
-          type: Result
-          properties: 
-            status: 500
-            title: An error occurred

package/blocks/container/Span.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: Span
-    category: container
-    schema: ../blocks/blocksBasic/src/blocks/Span/Span.json
-    filePath: blocks/container/Span.yaml
-    description_content: |
-      A Span is a container that places sub-blocks into a html `<span>`.
-      The Span has a single area, `content`.
-
-    areas:
-      - content

package/blocks/container/Spin.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: Spin
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Spin/Spin.json
-    filePath: blocks/container/Spin.yaml
-    description_content: |
-      A loading spinner. Can be used as a display block, or as container wrapping another block, with the `spinning` property set in `state`.
-    areas:
-      - content
-      # - indicator
-

package/blocks/container/Tabs.yaml

@@ -1,41 +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: Tabs
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Tabs/Tabs.json
-    description_content: |
-      Tabs to easily switch between different views.
-      The key of each tabs is the area keys of the container and there is an `extra` content area.
-    init_state_values:
-      block.properties.extraAreaKey: extra
-      block.properties.tabs:
-        - key: tab1
-          title: Tab 1
-          icon: MenuOutlined
-        - key: tab2
-          title: Tab 2
-        - key: tab3
-          disabled: true
-          title: Tab 3
-    user_defined_areas: true
-    areas:
-      - tab1
-      - tab2
-      - tab3
-      - panel3
-      - extra

package/blocks/container/Tooltip.yaml

@@ -1,38 +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: Tooltip
-    category: container
-    schema: ../blocks/blocksAntd/src/blocks/Tooltip/Tooltip.json
-    description_content: |
-      A simple text popup tip. Can be used to display extra information about its children blocks.
-    init_state_values:
-      block.properties.title: Tooltip title
-    areas:
-      - content
-    examples:
-      - title: Button tooltip
-        block:
-          id: button_ex
-          type: Tooltip
-          properties:
-            title: Explains what happens when this button is clicked.
-          blocks:
-            - id: btn
-              type: Button
-              properties:
-                title: Button

package/blocks/context/Context.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: Context
-    category: context
-    schema: ../blocks/blocksBasic/src/blocks/Context/Context.json
-    filePath: blocks/context/Context.yaml
-    description_content: |
-      The `Context` block creates a new context. It can be used at a page level to create the context for the page, or it can be used inside a page to create a separate context (for example to create a new context for a web form).
-
-    areas:
-      - content
-

package/blocks/context/PageHCF.yaml

@@ -1,28 +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: PageHCF
-    category: context
-    schema: ../blocks/blocksAntd/src/blocks/PageHCF/PageHCF.json
-    filePath: blocks/context/PageHCF.yaml
-    description_content: |
-      Page HCF provides a minimal layout structure for a page container with a header, content and footer area.
-
-    areas:
-      - content
-      - footer
-      - header

package/blocks/context/PageHCSF.yaml

@@ -1,29 +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: PageHCSF
-    category: context
-    schema: ../blocks/blocksAntd/src/blocks/PageHCSF/PageHCSF.json
-    filePath: blocks/context/PageHCSF.yaml
-    description_content: |
-      Page HCSF provides a minimal layout structure for a page container with a header, content, sider and footer arrangement.
-
-    areas:
-      - content
-      - footer
-      - header
-      - sider

package/blocks/context/PageHSCF.yaml

@@ -1,29 +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: PageHSCF
-    category: context
-    schema: ../blocks/blocksAntd/src/blocks/PageHSCF/PageHSCF.json
-    filePath: blocks/context/PageHSCF.yaml
-    description_content: |
-      Page HSCF provides a minimal layout structure for a page container with a header, sider, content, and footer arrangement.
-
-    areas:
-      - content
-      - footer
-      - header
-      - sider