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

package/blocks/input/TextArea.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: TextArea
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/TextArea/schema.json
-    filePath: blocks/input/TextArea.yaml
-    init_state_values:
-      __type_block.properties.autoSize: boolean
-      __boolean_block.properties.autoSize: true
-    description_content: |
-      The `TextArea` block is a text input that has multiple rows of input. It can be set to a fixed number of rows, or it can expand automatically as the user inputs more text.

package/blocks/input/TextInput.yaml

@@ -1,59 +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: TextInput
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/TextInput/schema.json
-    filePath: blocks/input/TextInput.yaml
-    description_content: |
-      The `TextInput` block is a single line text input.
-
-    examples:
-      - title: Required text input
-        block:
-          id: required_example
-          type: TextInput
-          required: true
-          properties:
-            title: Required text input
-      - title: Placeholder
-        block:
-          id: placeholder_example
-          type: TextInput
-          properties:
-            placeholder: Placeholder
-      - title: Prefix and suffix text
-        block:
-          id: prefix_suffix_example
-          type: TextInput
-          properties:
-            label:
-              extra: Prefix and suffix text
-            prefix: The cat
-            placeholder: chased
-            suffix: the rat
-      - title: User name
-        block:
-          id: username
-          type: TextInput
-          properties:
-            title: First Name
-            suffixIcon: AiOutlinedUser
-            placeholder: Your name
-            label:
-              span: 6

package/blocks/input/TitleInput.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: TitleInput
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/TitleInput/schema.json
-    filePath: blocks/input/TitleInput.yaml
-    init_state_values:
-      __type_block.properties.copyable: boolean
-      __type_block.properties.ellipsis: boolean
-      __type_block.properties.editable: boolean
-      __boolean_block.properties.copyable: false
-      __boolean_block.properties.ellipsis: false
-      __boolean_block.properties.editable: true
-      block_id: Click edit to change the title.
-    description_content: |
-      The `TitleInput` block can display a title, yet allow the user to click a edit icon and change the title. This is useful when the UI renders an existing document with a title, which a user must be able to edit.

package/blocks/input/TwitterColorSelector.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: TwitterColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/TwitterColorSelector/schema.json
-    filePath: blocks/input/TwitterColorSelector.yaml
-    description_content: |
-      A color selector component similar to the twitter color selector..

package/blocks/input/WeekSelector.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: WeekSelector
-    value_type: date
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/WeekSelector/schema.json
-    filePath: blocks/input/WeekSelector.yaml
-    description_content: |
-      The `WeekSelector` block allows a user to select a week. The value is a date object, with day and time values of midnight on the first monday of the week GMT.
-
-      > Other date type blocks are `DateRangeSelector`, `DateSelector`, `DateTimeSelector` and `MonthSelector`.

package/blocks/list/ControlledList.yaml

@@ -1,191 +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: ControlledList
-    category: list
-    schema: ../plugins/blocks/blocks-antd/src/blocks/ControlledList/schema.json
-    filePath: blocks/ControlledList/ControlledList.yaml
-    description_content: |
-      The ControlledList block renders a content area for all items in the array into the list card and provides easy UI elements to add or remove items in the list. All list blocks create a array in state at their block `id`. The list content areas are rendered for each index in the array. See the [List Concept](/lists) page for a detailed description on how to work with lists.
-    areas:
-      - content
-    methods:
-      - name: pushItem
-        onClick:
-          - id: pushItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: pushItem
-      - name: unshiftItem
-        onClick:
-          - id: unshiftItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: unshiftItem
-      - name: removeItem at index 1
-        onClick:
-          - id: removeItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: removeItem
-              args:
-                - 1
-      - name: for index 1 moveItemDown
-        onClick:
-          - id: moveItemDown
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: moveItemDown
-              args:
-                - 1
-      - name: for index 1 moveItemUp
-        onClick:
-          - id: moveItemUp
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: moveItemUp
-              args:
-                - 1
-    init_state_values:
-      todos:
-        - Add the noodles.
-        - Let it cook for a minute.
-        - Add some 🌶.
-    examples:
-      - title: Todo List
-        block:
-          id: todos
-          type: ControlledList
-          blocks:
-            - id: todos.$
-              type: TitleInput
-              properties:
-                level: 4
-        extra:
-          id: ex_state
-          type: MarkdownWithCode
-          style:
-            paddingTop: 16
-          properties:
-            content:
-              _nunjucks:
-                template: |
-                  ###### Todos State Value:
-                  ```yaml
-                  {{ value | safe }}
-                  ```
-                on:
-                  value:
-                    _yaml.stringify:
-                      on:
-                        todos:
-                          _state: todos
-                      options:
-                        sortKeys: false
-      - title: List of Contacts
-        block:
-          id: contacts
-          type: ControlledList
-          blocks:
-            - id: contacts.$.first_name
-              type: TextInput
-              layout:
-                span: 12
-              required: true
-              properties:
-                title: First Name
-                label:
-                  span: 10
-                  align: right
-            - id: contacts.$.last_name
-              type: TextInput
-              layout:
-                span: 12
-              required: true
-              properties:
-                title: Last Name
-                label:
-                  span: 10
-                  align: right
-
-            - id: contacts.$.date_of_birth
-              type: DateSelector
-              layout:
-                span: 12
-              required: true
-              properties:
-                title: Date of Birth
-                label:
-                  span: 10
-                  align: right
-            - id: contacts.$.email
-              type: TextInput
-              layout:
-                span: 12
-              required: true
-              properties:
-                title: Email address
-                label:
-                  span: 10
-                  align: right
-            - id: contacts.$.phone_number
-              type: TextInput
-              layout:
-                span: 12
-              properties:
-                title: Phone number
-                label:
-                  span: 10
-                  align: right
-            - id: contacts.$.preference
-              type: ButtonSelector
-              layout:
-                span: 12
-              properties:
-                title: Preference
-                label:
-                  span: 10
-                  align: right
-                options:
-                  - Phone
-                  - Email
-        extra:
-          id: ex_state
-          type: MarkdownWithCode
-          style:
-            paddingTop: 16
-          properties:
-            content:
-              _nunjucks:
-                template: |
-                  ###### Contacts State Value:
-                  ```yaml
-                  {{ value | safe }}
-                  ```
-                on:
-                  value:
-                    _yaml.stringify:
-                      on:
-                        contacts:
-                          _state: contacts
-                      options:
-                        sortKeys: false

package/blocks/list/List.yaml

@@ -1,157 +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: List
-    category: list
-    schema: ../plugins/blocks/blocks-basic/src/blocks/List/schema.json
-    filePath: blocks/list/List.yaml
-    description_content: |
-      The List block renders a content area for all items in the array. All list blocks create a array in state at their block `id`. The list content areas are rendered for each index in the array. See the [List Concept](/lists) page for a detailed description on how to work with lists.
-    areas:
-      - content
-    init_state_values:
-      todos:
-        - Bake a 🧁
-        - Eat a🍦
-        - Phone a 🦖
-    methods:
-      - name: pushItem
-        onClick:
-          - id: pushItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: pushItem
-      - name: unshiftItem
-        onClick:
-          - id: unshiftItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: unshiftItem
-      - name: removeItem at index 1
-        onClick:
-          - id: removeItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: removeItem
-              args:
-                - 1
-      - name: for index 1 moveItemDown
-        onClick:
-          - id: moveItemDown
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: moveItemDown
-              args:
-                - 1
-      - name: for index 1 moveItemUp
-        onClick:
-          - id: moveItemUp
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: moveItemUp
-              args:
-                - 1
-    examples:
-      - title: Todo List
-        block:
-          id: todo_app
-          type: Box
-          layout:
-            contentGutter: 16
-          blocks:
-            - id: todo_input
-              type: TextInput
-              layout:
-                grow: 1
-              properties:
-                label:
-                  disabled: true
-                placeholder: Write something todo...
-            - id: add_item
-              type: Button
-              layout:
-                shrink: 1
-              properties:
-                title: Add item
-                icon: AiOutlinedPlus
-              events:
-                onClick:
-                  - id: add
-                    type: SetState
-                    params:
-                      todos:
-                        _array.concat:
-                          - [_state: todo_input]
-                          - _state: todos
-                      todo_input: null
-            - id: todos
-              type: List
-              layout:
-                contentGutter: 16
-              blocks:
-                - id: todos.$
-                  type: TitleInput
-                  layout:
-                    grow: 1
-                  properties:
-                    level: 4
-                - id: remove_item
-                  type: Icon
-                  layout:
-                    shrink: 1
-                  properties:
-                    name: AiOutlinedMinusCircle
-                    size: 18
-                  events:
-                    onClick:
-                      - id: remove
-                        type: CallMethod
-                        messages:
-                          loading: sd f sdfgsdfg
-                          success: hi sdfg sdfgs g
-                        params:
-                          blockId: todos
-                          method: removeItem
-                          args:
-                            - _index: 0
-
-        extra:
-          id: ex_state
-          type: MarkdownWithCode
-          style:
-            paddingTop: 16
-          properties:
-            content:
-              _nunjucks:
-                template: |
-                  ###### Todos State Value:
-                  ```yaml
-                  {{ value | safe }}
-                  ```
-                on:
-                  value:
-                    _yaml.stringify:
-                      on:
-                        todos:
-                          _state: todos
-                      options:
-                        sortKeys: false

package/blocks/list/TimelineList.yaml

@@ -1,136 +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.
-
-# TODO: Fix schema to add to docs
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: TimelineList
-    category: list
-    schema: ../plugins/blocks/blocks-antd/src/blocks/TimelineList/schema.json
-    filePath: blocks/TimelineList/TimelineList.yaml
-    description_content: |
-      The TimelineList block renders a content area for all items in the array. All list blocks create a array in state at their block `id`. The list content areas are rendered for each index in the array. See the [List Concept](/lists) page for a detailed description on how to work with lists.
-
-      The timeline nodes can be customized based on the array data.
-    areas:
-      - content
-    init_state_values:
-      shipment_events:
-        - type: Order Placed
-          icon: AiTwoToneShoppingCart
-          color: '#2f54eb'
-          orderNumber: 2112
-          timestamp:
-            _date: '2021-02-10T20:30:00.000Z'
-          item:
-            code: ax2m-83kl9-ck
-            title: Useless Glue
-        - type: Shipped
-          icon: AiTwoToneGift
-          color: '#fa8c16'
-          orderNumber: 2112
-          timestamp:
-            _date: '2021-02-11T08:33:00.000Z'
-        - type: Cleared Customs
-          icon: AiTwoToneFileDone
-          color: '#13c2c2'
-          orderNumber: 2112
-          timestamp:
-            _date: '2021-02-11T16:12:00.000Z'
-        - type: Delivered
-          icon: AiTwoToneCheckCircle
-          color: '#52c41a'
-          orderNumber: 2112
-          timestamp:
-            _date: '2021-02-11T16:12:00.000Z'
-
-    methods:
-      - name: pushItem
-        onClick:
-          - id: pushItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: pushItem
-      - name: unshiftItem
-        onClick:
-          - id: unshiftItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: unshiftItem
-      - name: removeItem at index 1
-        onClick:
-          - id: removeItem
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: removeItem
-              args:
-                - 1
-      - name: for index 1 moveItemDown
-        onClick:
-          - id: moveItemDown
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: moveItemDown
-              args:
-                - 1
-      - name: for index 1 moveItemUp
-        onClick:
-          - id: moveItemUp
-            type: CallMethod
-            params:
-              blockId: block_id
-              method: moveItemUp
-              args:
-                - 1
-    examples:
-      - title: Shipment Event Log
-        block:
-          id: shipment_events
-          type: TimelineList
-          blocks:
-            - id: todo_input
-              type: TextInput
-              layout:
-                grow: 1
-              properties:
-                label:
-                  disabled: true
-                placeholder: Write something todo...
-        extra:
-          id: ex_state
-          type: MarkdownWithCode
-          style:
-            paddingTop: 16
-          properties:
-            content:
-              _nunjucks:
-                template: |
-                  ###### Shipment Events State Value:
-                  ```yaml
-                  {{ value | safe }}
-                  ```
-                on:
-                  value:
-                    _yaml.stringify:
-                      on:
-                        shipment_events:
-                          _state: shipment_events
-                      options:
-                        sortKeys: false

package/body.html

@@ -1 +0,0 @@
-<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2.6.3/dist/cdn/docsearch.min.js"></script>