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

package/actions/Notification.yaml

@@ -1,84 +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/actions.yaml.njk
-  vars:
-    pageId: NotificationAction
-    pageTitle: Notification
-    filePath: actions/Notification.yaml
-    types: |
-      ```
-      (params: {
-        status?: enum,
-        duration?: number,
-        message?: string,
-        description?: string,
-        placement?: enum,
-        bottom?: number,
-        top?: number
-      }): void
-      ```
-    description: |
-      The `Notification` action is used to display a notification message to a user.
-    params: |
-      ###### object
-        - `status: enum`: Message status type. Defaults to `success`. One of:
-          - `success`
-          - `error`
-          - `info`
-          - `warning`
-          - `loading`.
-        - `duration: number`: Time in seconds before the notification disappears. When set to 0 or null, it will never be closed automatically. The default is 5.
-        - `message: string`: The title of notification. Default is "Success".
-        - `description: sttring`: The content of the notification.
-        - `placement: enum`: Position of the notification. Default is `bottomRight`. Can be one of:
-          - `topLeft`
-          - `topRight`
-          - `bottomLeft`
-          - `bottomRight`
-        - `bottom: number`: Distance from the bottom of the viewport, when placement is `bottomRight`or `bottomLeft` in pixels.  The default is 24.
-        - `top: number`: Distance from the bottom of the viewport, when placement is `topRight`or `topLeft` in pixels.  The default is 24.
-    examples: |
-      ###### Display a success notification:
-      ```yaml
-      - id: success
-        type: Notification
-        params:
-          message: Hello
-      ```
-
-      ###### Display an info notification with a description:
-      ```yaml
-      - id: info
-        type: Notification
-        params:
-          message: Something happened
-          status: info
-          description: This is a longer description of the thing that happened, so that you know why it happened.
-          duration: 10
-          placement: topRight
-      ```
-
-      ###### Display an warning notification that does not disappear until closed:
-      ```yaml
-      - id: warning
-        type: Notification
-        params:
-          message: Something bad might happen.
-          status: warning
-          description: This is a longer description of the thing that happened, so that you know why it happened.
-          duration: 0
-          placement: topRight
-      ```

package/actions/Request.yaml

@@ -1,70 +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/actions.yaml.njk
-  vars:
-    pageId: Request
-    pageTitle: Request
-    filePath: actions/Request.yaml
-    types: |
-      ```
-      (options: {all: boolean}): void
-      (requestId: string): void
-      (requestIds: string[]): void
-      ```
-    description: |
-      The `Request` action calls a request, or if used during an `onInit` or `onEnter` events, calls those requests while a page loads.
-      `Request` can be used to call all requests on a `context`, a list of requests, or a single request. The `Request` action is synchronous, actions defined after
-      it will only run once all the called requests have returned.
-
-      To call requests that load data, the `onInitAsync` and `onEnterAsync` events can be used. These will execute the actions while the page begins to render. If the `onInit` or `onEnter` events are used, the page will only start rendering after the actions have completed.
-
-      `Request` can be called without any parameters to call all requests in the `context`. It can also be called with a list of requestIds or a single requestId to call.
-
-    params: |
-      ###### object
-      - `all: boolean`: All requests in the context are called if `all` is set to true.
-
-      ###### string
-      A requestId of the request to call.
-
-      ###### string[]
-      An array of requestIds of the requests to call.
-
-    examples: |
-      ###### Call a single request:
-      ```yaml
-      - id: call_one_request
-        type: Request
-        params: my_request_id
-      ```
-
-      ###### Call a list of requests:
-      ```yaml
-      - id: call_many_requests
-        type: Request
-        params:
-          - my_request_id_1
-          - my_request_id_2
-          - my_request_id_3
-      ```
-      ###### Call all requests:
-
-      ```yaml
-      - id: call_all
-        type: Request
-        params:
-          all: true
-      ```

package/actions/Reset.yaml

@@ -1,42 +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/actions.yaml.njk
-  vars:
-    pageId: Reset
-    pageTitle: Reset
-    filePath: actions/Reset.yaml
-    types: |
-      ```
-      (void): void
-      ```
-    description: |
-      The `Reset` actions resets a context to the state it was in just after the `onInit` event was executed. This clears the user's inputs.
-
-      >  The `Reset` action resets the state to the state before the `onEnter` event is executed, and the `onEnter` event is not executed after the reset happens. This might cause unexpected behavior if you used an `onEnter` event to initialize the state.
-    params: |
-      The `Reset` action does not take any parameters.
-    examples: |
-      ###### A reset button:
-      ```yaml
-      - id: reset_button
-        type: Button
-        properties:
-          title: Reset
-        events:
-          onClick:
-            - id: reset
-              type: Reset
-      ```

package/actions/ResetValidation.yaml

@@ -1,102 +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/actions.yaml.njk
-  vars:
-    pageId: ResetValidation
-    pageTitle: ResetValidation
-    filePath: actions/ResetValidation.yaml
-    types: |
-      ```
-      (void): void
-      (blockId: string): void
-      (blockIds: string[]): void
-      (params: {
-        blockId?: string|string[],
-        regex?: string|string[],
-      }): void
-      ```
-    description: |
-      The `ResetValidation` action is used to reset validation flags on input fields.
-
-      By default when a page is opened, no validation flags are set on any input fields. When the `Validate` is called, a validation flag is set on input fields matching the validation params. To reset the validation flags, use the `ResetValidation` action.
-
-      The `ResetValidation` action `blockIds` or `regex` params are used to limit which blocks validation errors and warnings should be reset.
-
-    params: |
-      ###### void
-      The `ResetValidation` action lowers validation flags on all blocks on the page if called without params.
-
-      ###### string
-      A blockId of the block for which to lower validation flags.
-
-      ###### string[]
-      An array of blockIds of the blocks for which to lower validation flags.
-
-      ###### object
-        - `blockId?: string|string[]`: A blockId or an array of the blockIds of the blocks for which to lower validation flags
-        - `regex?: string|string[]`: A regex string pattern or an array of regex string patterns to match the blockIds for which to lower validation flags.
-
-    examples: |
-      ###### Lower validation flags for all inputs on the page:
-      ```yaml
-      - id: reset_all
-        type: ResetValidation
-      ```
-
-      ###### Lower validation flags for a single input:
-      ```yaml
-      - id: reset_my_input
-        type: ResetValidation
-        params: my_input
-      ```
-
-      ###### Lower validation flags for a list of inputs:
-      ```yaml
-      - id: reset_input_a_and_b
-        type: ResetValidation
-        params:
-          - my_input_a
-          - my_input_b
-      ```
-
-      ###### Lower validation flags for all inputs matching a regex pattern:
-      ```yaml
-      - id: reset_foo
-        type: ResetValidation
-        params:
-          regex: ^foo\.
-      ```
-
-      ###### Lower validation flags for all inputs matching a list of regex patterns:
-      ```yaml
-      - id: reset_foo_and_price
-        type: ResetValidation
-        params:
-          regex:
-            - ^foo\.
-            - ^.*price.*$
-      ```
-
-      ###### Lower validation flags for all inputs matching a list of regex patterns and a blockId:
-      ```yaml
-      - id: reset_foo_price_and_my_input
-        type: ResetValidation
-        params:
-          blockId: my_input
-          regex:
-            - ^foo\.
-            - ^.*price.*$
-      ```

package/actions/ScrollTo.yaml

@@ -1,100 +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/actions.yaml.njk
-  vars:
-    pageId: ScrollTo
-    pageTitle: ScrollTo
-    filePath: actions/ScrollTo.yaml
-    types: |
-      ```
-      (params: {
-        top?: number,
-        left?: number,
-        behavior?: enum
-      }): void
-
-      (params: {
-        blockId: string,
-        options: {
-          behavior?: enum,
-          block? enum,
-          inline?: enum
-        }
-      }): void
-      ```
-    description: |
-      The `ScrollTo` action is used to scroll the users browser. It is often used to scroll back to the top
-      of a long form after resetting the form, or to scroll the user to the top of a page after linking to a new page.
-
-      The `ScrollTo` action has two modes - scrolling to a block and scrolling to x and y coordinates on a page.
-
-      > When scrolling to a block, `ScrollTo` implements [`Element.scrollIntoView()`](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView), while
-      when scrolling to coordinates, it implements [`Window.scrollTo()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/scrollTo).
-    params: |
-      ######  Scroll to coordinates
-      - `top: number`: Specifies the number of pixels along the Y axis to scroll the window.
-      - `left: number`: Specifies the number of pixels along the X axis to scroll the window.
-      - `behavior: enum`: Defines the transition animation. One of `auto` or `smooth`.
-
-      ######  Scroll to a block
-      - `blockId: string`: __Required__ - The blockId of a block to scroll to.
-      - `options: object`: _Object_
-        - `behavior: enum`: Defines the transition animation. One of `auto` or `smooth`. Defaults to `auto`.
-        - `block: enum`: Defines vertical alignment. One of `start`, `center`, `end`, or `nearest`. Defaults to `start`.
-        - `inline: enum`: Defines horizontal alignment. One of `start`, `center`, `end`, or `nearest`. Defaults to `nearest`.
-    examples: |
-      ######  Scroll to a block:
-      ```yaml
-      - id: scroll_to_block
-        type: ScrollTo
-        params:
-          blockId: my_block
-      ```
-
-      ######  Scroll to the top of the page:
-      ```yaml
-      - id: scroll_to_top
-        type: ScrollTo
-        params:
-          top: 0
-      ```
-
-      ######  Scroll to the top of the page after linking from a previous page:
-      ```yaml
-      - id: link_button
-        type: Button
-        events:
-          onClick:
-            - id: link_
-              type: Link
-              params:
-                pageId: next_page
-            - id: scroll_to_top
-              type: ScrollTo
-              params:
-                top: 0
-      ```
-
-      ######  Scroll to the centre of a block:
-      ```yaml
-      - id: scroll_to_block
-        type: ScrollTo
-        params:
-          blockId: my_block
-          options:
-            block: center
-            inline: center
-      ```

package/actions/SetGlobal.yaml

@@ -1,78 +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/actions.yaml.njk
-  vars:
-    pageId: SetGlobal
-    pageTitle: SetGlobal
-    filePath: actions/SetGlobal.yaml
-    types: |
-      ```
-      (toSet: object): void
-      ```
-    description: |
-      The `SetGlobal` action sets values to the `global` object. It takes an object as parameters, and sets each of those values to the `global` object.
-      This is useful if you need to set a value that needs to be available across multiple pages in the app, like the id of a currently selected
-      object. `SetGlobal` works just like `SetState`, except it sets to the `global` object and not `state`.
-    params: |
-      ###### object
-      Object with key value pairs to set in `global`.
-    examples: |
-      ###### Set a single value to global:
-      ```yaml
-      - id: set_selected_company
-        type: SetGlobal
-        params:
-          selected_selected_company:
-            _state: company.id
-      ```
-
-      ###### Set multiple values to state:
-      ```yaml
-      - id: multiple_values
-        type: SetGlobal
-        params:
-          firstName: Monica
-          lastName: Geller
-          address:
-            street: 90 Bedford St
-            city: New York
-            zipCode: '10014'
-            country: US
-          friends:
-            - Ross Geller
-            - Rachel Green
-            - Chandler Bing
-            - Phoebe Buffay
-            - Joey Tribbiani
-      ```
-
-      ###### Using dot notation:
-      ```yaml
-      - id: dot_notation
-        type: SetGlobal
-        params:
-          firstName: Monica
-          lastName: Geller
-          address.street: 90 Bedford St
-          address.city: New York
-          address.zipCode: '10014'
-          address.country: US
-          friends.0: Ross Geller
-          friends.1: Rachel Green
-          friends.2: Chandler Bing
-          friends.3: Phoebe Buffay
-          friends.5: Joey Tribbiani
-      ```

package/actions/SetState.yaml

@@ -1,85 +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/actions.yaml.njk
-  vars:
-    pageId: SetState
-    pageTitle: SetState
-    filePath: actions/SetState.yaml
-    types: |
-      ```
-      (toSet: object): void
-      ```
-    description: |
-      The `SetState` action sets values in `state`. It takes an object as parameters, and sets each of those values to the `state` object.
-      This is useful if you want to initialize `state`, set a flag after an action has executed (eg. to disable a button), or to set the result
-      of a request to state.
-    params: |
-      ###### object
-      Object with key value pairs to set in `state`.
-    examples: |
-      ###### Set a single value to state:
-      ```yaml
-      - id: single_value
-        type: SetState
-        params:
-          message: Hello
-      ```
-
-      ###### Set multiple values to state:
-      ```yaml
-      - id: multiple_values
-        type: SetState
-        params:
-          firstName: Monica
-          lastName: Geller
-          address:
-            street: 90 Bedford St
-            city: New York
-            zipCode: '10014'
-            country: US
-          friends:
-            - Ross Geller
-            - Rachel Green
-            - Chandler Bing
-            - Phoebe Buffay
-            - Joey Tribbiani
-      ```
-
-      ###### Using dot notation:
-      ```yaml
-      - id: dot_notation
-        type: SetState
-        params:
-          firstName: Monica
-          lastName: Geller
-          address.street: 90 Bedford St
-          address.city: New York
-          address.zipCode: '10014'
-          address.country: US
-          friends.0: Ross Geller
-          friends.1: Rachel Green
-          friends.2: Chandler Bing
-          friends.3: Phoebe Buffay
-          friends.5: Joey Tribbiani
-      ```
-
-      ###### Initialize state with the value of a request:
-      ```yaml
-      - id: initialize
-        type: SetState
-        params:
-          _request: getUser
-      ```

package/actions/Throw.yaml

@@ -1,89 +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/actions.yaml.njk
-  vars:
-    pageId: Throw
-    pageTitle: Throw
-    filePath: actions/Throw.yaml
-    types: |
-      ```
-      (params: {
-        throw?: boolean,
-        message?: string,
-        metaData?: any
-      }): void
-      ```
-    description: |
-      The `Throw` action is used throw an error to the user and log to the console. If `throw: true`, the `Throw`
-      action will throw an error, and this will stop the execution of actions that are defined after it. If the action does not thrown, the `Throw` action will do nothing and the actions defined after it will be executed.
-
-    params: |
-      - `throw: boolean`: Throws an error and stops the action chain when `true` or continues the action chain when `false` or undefined.
-      - `message: string`: The error message to show to the user and log to the console if `throw: true`. This message can be overridden by setting the action's `messages.error`.
-      - `metaData: any`: Data to log to the console if `throw: true`.
-
-    examples: |
-      ###### Throw with custom message:
-      ```yaml
-      - id: throw
-        type: Throw
-        params:
-          throw:
-            _eq:
-              - _state: lukes_father
-              - Darth Vader
-          message: Nooooooooooooooooo
-      ```
-
-      ###### Throw with metaData:
-      ```yaml
-      - id: throw
-        type: Throw
-        params:
-          throw:
-            _eq:
-              - _state: lukes_father
-              - Darth Vader
-          message: Nooooooooooooooooo
-          metaData:
-            realisation: Luke kissed his sister
-      ```
-      ###### Override custom message:
-      ```yaml
-      - id: throw
-        type: Throw
-        messages:
-          error: Meh.
-        params:
-          throw:
-            _eq:
-              - _state: lukes_father
-              - Darth Vader
-          message: Nooooooooooooooooo
-      ```
-      ###### Fail silently:
-      ```yaml
-      - id: throw
-        type: Throw
-        messages:
-          error: false
-        params:
-          throw:
-            _eq:
-              - _state: lukes_father
-              - Darth Vader
-          message: Nooooooooooooooooo
-      ```