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

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: ../plugins/blocks/blocks-antd/src/blocks/Affix/schema.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/Alert.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: Alert
-    category: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Alert/schema.json
-    filePath: blocks/container/Alert.yaml
-    init_property_values:
-      message: Alerts help to highlight important information.
-    description_content: |
-      Alert is used to render user feedback messages in a Alert styled frame.
-    areas:
-      - action

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: ../plugins/blocks/blocks-antd/src/blocks/Badge/schema.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: ../plugins/blocks/blocks-basic/src/blocks/Box/schema.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: ../plugins/blocks/blocks-antd/src/blocks/Card/schema.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: ../plugins/blocks/blocks-antd/src/blocks/Collapse/schema.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: ../plugins/blocks/blocks-antd/src/blocks/Comment/schema.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: ../plugins/blocks/blocks-antd/src/blocks/ConfirmModal/schema.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/Descriptions.yaml

@@ -1,51 +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: Descriptions
-    category: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Descriptions/schema.json
-    filePath: blocks/container/Descriptions.yaml
-    init_state_values:
-      __type_block.properties.column: number
-      __type_block.properties.items: object[]
-      __object_arr_block.properties.items:
-        - label: Item One
-          value: 1
-        - label: Item Two
-          value: 2
-        - label: Item Three
-          value: 3
-        - label: Item Four
-          value: 4
-          span: 3
-
-    description_content: |
-      Display multiple read-only fields in groups. Commonly used to display a detailed set of data.
-
-    examples:
-      - title: Object data example
-        block:
-          id: object_example
-          type: Descriptions
-          properties:
-            bordered: true
-            items:
-              Location: South Africa
-              Temperature: 22
-              Date: 2021-02-02
-    areas:
-      - extra

package/blocks/container/Drawer.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: Drawer
-    category: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Drawer/schema.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
-      - extra
-    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,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: Label
-    category: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Label/schema.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: ../plugins/blocks/blocks-antd/src/blocks/Modal/schema.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/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: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/PageHCF/schema.json
-    filePath: blocks/container/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/container/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: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/PageHCSF/schema.json
-    filePath: blocks/container/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/container/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: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/PageHSCF/schema.json
-    filePath: blocks/container/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

package/blocks/container/PageHeaderMenu.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: PageHeaderMenu
-    category: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/PageHeaderMenu/schema.json
-    filePath: blocks/container/PageHeaderMenu.yaml
-    description_content: |
-      The Page Header Menu block provides a structured layout for a page with a header containing a menu, content and footer area.
-    init_state_values:
-      block.properties.menu.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
-    areas:
-      - content
-      - footer
-      - header

package/blocks/container/PageSHCF.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: PageSHCF
-    category: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/PageSHCF/schema.json
-    filePath: blocks/container/PageSHCF.yaml
-    description_content: |
-      Page SHCF provides a minimal layout structure for a page container with a sider, header, content, and footer arrangement.
-
-    areas:
-      - content
-      - footer
-      - header
-      - sider

package/blocks/container/PageSiderMenu.yaml

@@ -1,53 +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: PageSiderMenu
-    category: container
-    schema: ../plugins/blocks/blocks-antd/src/blocks/PageSiderMenu/schema.json
-    filePath: blocks/container/PageSiderMenu.yaml
-    description_content: |
-      The Page Sider Menu block provides a structured layout for a page with a header, sider including menu, content and footer area.
-    init_state_values:
-      block.properties.menu.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
-    areas:
-      - content
-      - footer
-      - header
-      - sider