mirror of
https://github.com/lowdefy/lowdefy.git
synced 2025-03-01 14:46:26 +08:00
Merge pull request #390 from lowdefy/docs-fixes
Docs and event rename fixes
This commit is contained in:
commit
c7d92f214d
@ -62,7 +62,7 @@ const PageHSCF = ({ blockId, events, content, properties, methods }) => (
|
||||
content: () => content.sider(),
|
||||
}}
|
||||
rename={{
|
||||
actions: {
|
||||
events: {
|
||||
onClose: 'onSiderClose',
|
||||
onOpen: 'onSiderOpen',
|
||||
},
|
||||
|
@ -7,10 +7,7 @@
|
||||
"connection": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"required": ["id", "type"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -42,10 +39,7 @@
|
||||
"block": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"required": ["id", "type"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -59,6 +53,12 @@
|
||||
"type": "Block \"type\" should be a string."
|
||||
}
|
||||
},
|
||||
"field": {
|
||||
"type": "string",
|
||||
"errorMessage": {
|
||||
"type": "Block \"field\" should be a string."
|
||||
}
|
||||
},
|
||||
"properties": {
|
||||
"type": "object"
|
||||
},
|
||||
@ -163,11 +163,7 @@
|
||||
"request": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type",
|
||||
"connectionId"
|
||||
],
|
||||
"required": ["id", "type", "connectionId"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -206,10 +202,7 @@
|
||||
"menuLink": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"required": ["id", "type"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -253,10 +246,7 @@
|
||||
"menuGroup": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"required": ["id", "type"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -307,9 +297,7 @@
|
||||
"menu": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"required": ["id"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -343,10 +331,7 @@
|
||||
"action": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"id",
|
||||
"type"
|
||||
],
|
||||
"required": ["id", "type"],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -385,9 +370,7 @@
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"lowdefy"
|
||||
],
|
||||
"required": ["lowdefy"],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
@ -473,4 +456,4 @@
|
||||
"lowdefy": "Lowdefy configuration should have required property \"lowdefy\"."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -34,7 +34,7 @@ _ref:
|
||||
type: Button
|
||||
properties:
|
||||
title: Reset
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: reset
|
||||
type: Reset
|
||||
|
@ -75,7 +75,7 @@ _ref:
|
||||
```yaml
|
||||
- id: link_button
|
||||
type: Button
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: link_
|
||||
type: Link
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
_ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Alert/Alert.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onClose
|
||||
Called when Alert close button is clicked.
|
||||
###### afterClose
|
||||
|
@ -31,7 +31,7 @@ _ref:
|
||||
_ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Anchor/Anchor.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onClick
|
||||
Called when Anchor is clicked.
|
||||
examples:
|
||||
|
@ -31,7 +31,7 @@ _ref:
|
||||
_ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Avatar/Avatar.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onClick
|
||||
Called when Avatar is clicked.
|
||||
examples:
|
||||
|
@ -36,7 +36,7 @@ _ref:
|
||||
_ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Breadcrumb/Breadcrumb.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onClick
|
||||
Triggered when breadcrumb item is clicked. Provides clicked link and index as args.
|
||||
examples:
|
||||
|
@ -31,7 +31,7 @@ _ref:
|
||||
_ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Button/Button.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onClick
|
||||
Called when the button is clicked.
|
||||
examples:
|
||||
|
@ -39,7 +39,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/AutoComplete/AutoComplete.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
###### onPressEnter
|
||||
|
@ -47,7 +47,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/ButtonSelector/ButtonSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -48,7 +48,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/CheckboxSelector/CheckboxSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/ChromeColorSelector/ChromeColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/CircleColorSelector/CircleColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/ColorSelector/ColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/ColorSelector/ColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/CompactColorSelector/CompactColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -35,7 +35,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/DateRangeSelector/DateRangeSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -35,7 +35,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/DateSelector/DateSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -37,7 +37,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/DateTimeSelector/DateTimeSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/GithubColorSelector/GithubColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -35,7 +35,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/MonthSelector/MonthSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -48,7 +48,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/MultipleSelector/MultipleSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/NumberInput/NumberInput.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
###### onPressEnter
|
||||
|
@ -42,7 +42,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Pagination/Pagination.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onSizeChange
|
||||
Triggered when page size is changed.
|
||||
###### onChange
|
||||
|
@ -41,7 +41,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/ParagraphInput/ParagraphInput.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
###### onCopy
|
||||
|
@ -48,7 +48,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/RadioSelector/RadioSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/RatingSlider/RatingSlider.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -37,7 +37,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/S3UploadButton/S3UploadButton.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -48,7 +48,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Selector/Selector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/SliderColorSelector/SliderColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/SwatchesColorSelector/SwatchesColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/Switch/Switch.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -36,7 +36,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/TextArea/TextArea.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
###### onPressEnter
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/TextInput/TextInput.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
###### onPressEnter
|
||||
|
@ -41,7 +41,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/TitleInput/TitleInput.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
###### onCopy
|
||||
|
@ -33,7 +33,7 @@ _ref:
|
||||
path: ../blocks/blocksColorSelectors/src/blocks/TwitterColorSelector/TwitterColorSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Trigger action when title is changed.
|
||||
|
||||
|
@ -35,7 +35,7 @@ _ref:
|
||||
path: ../blocks/blocksAntd/src/blocks/WeekSelector/WeekSelector.json
|
||||
transformer: templates/blocks/propertiesFormTransformer.js
|
||||
|
||||
available_actions_description: |
|
||||
event_description: |
|
||||
###### onChange
|
||||
Triggered when value is changed.
|
||||
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Concepts
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### TLDR
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Concepts
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
The Lowdefy CLI is used to develop a Lowdefy app locally, and to build Lowdefy apps for deployment.
|
||||
|
@ -41,7 +41,7 @@ _ref:
|
||||
|
||||
Every `input` category block inside the context will have a value in the `state` object, with the their `id` as the key in the `state` object, unless the block is not visible, in which case the input value is removed the state object.
|
||||
|
||||
The only other way to modify the `state` object is to use a `SetState` action. See [`SetState`](/SetState) and [`actions`](/actions) for more details.
|
||||
The only other way to modify the `state` object is to use a `SetState` action. See [`SetState`](/SetState) and [`events-and-actions`](/events-and-actions) for more details.
|
||||
|
||||
# Context data objects
|
||||
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Concepts
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
A Lowdefy app is written as YAML files, which are combined together using the `_ref` operator when the app is built, into a configuration object that describes the entire app. This object has different sections that describes different parts of the app.
|
||||
@ -142,8 +142,8 @@ _ref:
|
||||
|
||||
# References and templates
|
||||
|
||||
References are used to split the configuration of an app into logically distinct files, and to reuse configuration in the app. References can be used almost anywhere in the configuration, as long as the configuration remains valid YAML.
|
||||
|
||||
References are used to split the configuration of an app into logically distinct files, and to reuse configuration in the app. References can be used almost anywhere in the configuration, as long as the configuration remains valid YAML.
|
||||
|
||||
References are made using the [`_ref`](/_ref) operator. If the referenced file has a `.yaml` or `.json` extension, the contents of the file will be parsed, else the file content is included as a string (this is useful for `.md` or `.html` files). As an example of splitting an app into logically distinct files, references can be used to write each page as a separate file:
|
||||
|
||||
###### lowdefy.yaml
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Connections
|
||||
content:
|
||||
- id: markdown
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
AWS S3 is a file or data storage solution, provided by Amazon Web Services. S3 does not work like a traditional file system, data is stored as objects in a collection of objects called a bucket.
|
||||
@ -97,7 +97,7 @@ _ref:
|
||||
blocks:
|
||||
- id: getFileButton
|
||||
type: Button
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: open_file
|
||||
type: Link
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Connections
|
||||
content:
|
||||
- id: markdown
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
The `AxiosHTTP` connection is used to connect to APIs and web servers using HTTP or HTTPS.
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Connections
|
||||
content:
|
||||
- id: markdown
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
## Connections
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Connections
|
||||
content:
|
||||
- id: markdown
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
MongoDB is a NoSQL database that stores JSON-like documents. These documents are stored in collections, which are like database tables. The fields inside these document can differ from document to document, but generally they are all more or less the same. However documents with different schemas can be stored in the same collection.
|
||||
|
@ -35,7 +35,7 @@ _ref:
|
||||
size: large
|
||||
title: Start the tutorial
|
||||
type: primary
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: link_forward
|
||||
type: Link
|
||||
|
6
packages/docs/templates/actions.yaml.njk
vendored
6
packages/docs/templates/actions.yaml.njk
vendored
@ -30,7 +30,7 @@ _ref:
|
||||
content:
|
||||
_var: types
|
||||
- id: description
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_var: description
|
||||
@ -40,7 +40,7 @@ _ref:
|
||||
properties:
|
||||
content: '#### Parameters'
|
||||
- id: params
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_var: params
|
||||
@ -51,7 +51,7 @@ _ref:
|
||||
properties:
|
||||
content: '#### Examples'
|
||||
- id: examples
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_var: examples
|
||||
|
@ -32,7 +32,7 @@ blocks:
|
||||
- id: example_config_{{ loop.index }}
|
||||
layout:
|
||||
span: 12
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_nunjucks:
|
||||
|
18
packages/docs/templates/blocks/template.yaml.njk
vendored
18
packages/docs/templates/blocks/template.yaml.njk
vendored
@ -25,7 +25,7 @@ properties:
|
||||
background: '#FFFFFF'
|
||||
layout:
|
||||
contentGutter: 16
|
||||
actions:
|
||||
events:
|
||||
onInit:
|
||||
- id: init_default_properties
|
||||
type: SetState
|
||||
@ -110,7 +110,7 @@ blocks:
|
||||
- _var: category
|
||||
- input
|
||||
- id: state_markdown
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
visible:
|
||||
_eq:
|
||||
- _var: category
|
||||
@ -134,7 +134,7 @@ blocks:
|
||||
properties:
|
||||
title: Block Setup
|
||||
- id: setup_markdown
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_nunjucks:
|
||||
@ -166,7 +166,7 @@ blocks:
|
||||
vars:
|
||||
value:
|
||||
_state: block.layout
|
||||
default_value:
|
||||
default_value:
|
||||
align: top
|
||||
span: 24
|
||||
style:
|
||||
@ -229,8 +229,8 @@ blocks:
|
||||
title: 'layout:'
|
||||
- key: style
|
||||
title: 'style:'
|
||||
- key: actions
|
||||
title: 'actions:'
|
||||
- key: events
|
||||
title: 'events:'
|
||||
- key: required
|
||||
title: 'required:'
|
||||
disabled:
|
||||
@ -250,13 +250,13 @@ blocks:
|
||||
style:
|
||||
blocks:
|
||||
_ref: templates/blocks/style.yaml
|
||||
actions:
|
||||
events:
|
||||
blocks:
|
||||
- id: available_actions_description
|
||||
- id: event_description
|
||||
type: Markdown
|
||||
properties:
|
||||
content:
|
||||
_var: available_actions_description
|
||||
_var: event_description
|
||||
required:
|
||||
blocks:
|
||||
- id: block.required
|
||||
|
@ -32,7 +32,7 @@ blocks:
|
||||
title:
|
||||
_var: previous_page_title
|
||||
type: default
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: link_back
|
||||
type: Link
|
||||
@ -55,7 +55,7 @@ blocks:
|
||||
title:
|
||||
_var: next_page_title
|
||||
type: default
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: link_forward
|
||||
type: Link
|
||||
|
6
packages/docs/templates/operators.yaml.njk
vendored
6
packages/docs/templates/operators.yaml.njk
vendored
@ -32,7 +32,7 @@ page:
|
||||
content:
|
||||
_var: types
|
||||
- id: description
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_var: description
|
||||
@ -42,7 +42,7 @@ page:
|
||||
properties:
|
||||
content: '#### Arguments'
|
||||
- id: arguments
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_var: arguments
|
||||
@ -53,7 +53,7 @@ page:
|
||||
properties:
|
||||
content: '#### Examples'
|
||||
- id: examples
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content:
|
||||
_var: examples
|
||||
|
@ -39,7 +39,7 @@ function transformer(obj) {
|
||||
title: `${operatorName}.${method.name}`,
|
||||
icon: 'LinkOutlined',
|
||||
},
|
||||
actions: {
|
||||
events: {
|
||||
onClick: [
|
||||
{
|
||||
id: 'scroll',
|
||||
@ -75,7 +75,7 @@ function transformer(obj) {
|
||||
});
|
||||
contentArray.push({
|
||||
id: `${method.name}_description`,
|
||||
type: 'MarkdownWithHtml',
|
||||
type: 'MarkdownWithCode',
|
||||
properties: {
|
||||
content: method.description,
|
||||
},
|
||||
@ -90,7 +90,7 @@ function transformer(obj) {
|
||||
});
|
||||
contentArray.push({
|
||||
id: `${method.name}_arguments`,
|
||||
type: 'MarkdownWithHtml',
|
||||
type: 'MarkdownWithCode',
|
||||
properties: {
|
||||
content: method.arguments,
|
||||
},
|
||||
@ -106,7 +106,7 @@ function transformer(obj) {
|
||||
});
|
||||
contentArray.push({
|
||||
id: `${method.name}_examples`,
|
||||
type: 'MarkdownWithHtml',
|
||||
type: 'MarkdownWithCode',
|
||||
properties: {
|
||||
content: method.examples,
|
||||
},
|
||||
|
@ -21,7 +21,7 @@ _ref:
|
||||
# prefetchPages: []
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
Congratulations! You have completed the tutorial and built a sort-of functioning app.
|
||||
|
@ -20,7 +20,7 @@ _ref:
|
||||
section: Tutorial
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
##### `lowdefy.yaml`
|
||||
@ -117,7 +117,7 @@ _ref:
|
||||
block: true # Make the button fill all the space available to it
|
||||
type: default # Make the button a plain button
|
||||
icon: ClearOutlined
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: reset
|
||||
type: Reset
|
||||
@ -130,7 +130,7 @@ _ref:
|
||||
block: true
|
||||
type: primary # Make the button a primary button with color
|
||||
icon: SaveOutlined
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: validate
|
||||
type: Validate
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-requests
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
If you have been following along, you can continue with your current config. Else, you can find the config from the previous section [here](tutorial-add-blocks-config).
|
||||
@ -57,7 +57,7 @@ _ref:
|
||||
type: default
|
||||
icon: ClearOutlined
|
||||
################ -------- Copy from here -------- ################
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: reset
|
||||
type: Reset
|
||||
@ -96,7 +96,7 @@ _ref:
|
||||
properties:
|
||||
title: Title
|
||||
- id: md2
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
We can now add a `Validate` action to the submit button. This will validate the inputs and give an error if any inputs are not filled in.
|
||||
@ -126,7 +126,7 @@ _ref:
|
||||
type: primary
|
||||
icon: SaveOutlined
|
||||
################ -------- Copy from here -------- ################
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: validate
|
||||
type: Validate
|
||||
@ -181,7 +181,7 @@ _ref:
|
||||
block: true
|
||||
type: default
|
||||
icon: ClearOutlined
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: reset
|
||||
type: Reset
|
||||
@ -194,12 +194,12 @@ _ref:
|
||||
block: true
|
||||
type: primary
|
||||
icon: SaveOutlined
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: validate
|
||||
type: Validate
|
||||
- id: md3
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
renderHtml: true
|
||||
content: |
|
||||
@ -313,7 +313,7 @@ _ref:
|
||||
minHeight: 300px
|
||||
menu:
|
||||
links: []
|
||||
actions:
|
||||
events:
|
||||
onInit:
|
||||
- id: init
|
||||
type: SetState
|
||||
@ -379,7 +379,7 @@ _ref:
|
||||
block: true # Make the button fill all the space available to it
|
||||
type: default # Make the button a plain button
|
||||
icon: ClearOutlined
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: reset
|
||||
type: Reset
|
||||
@ -392,12 +392,12 @@ _ref:
|
||||
block: true
|
||||
type: primary # Make the button a primary button with color
|
||||
icon: SaveOutlined
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: validate
|
||||
type: Validate
|
||||
- id: md4
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
> You can find the final configuration files for this section [here](tutorial-actions-operators-config).
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-editing-page
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
##### `lowdefy.yaml`
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-actions-operators
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
We would like to add an input form with the following fields:
|
||||
@ -37,7 +37,7 @@ _ref:
|
||||
|
||||
Copy the following blocks and add them in the card's blocks array.
|
||||
|
||||
###### `pages/new-ticket.yaml`
|
||||
###### `pages/new-ticket.yaml`
|
||||
```yaml
|
||||
id: new-ticket
|
||||
# ...
|
||||
@ -149,7 +149,7 @@ _ref:
|
||||
type: primary
|
||||
icon: SaveOutlined
|
||||
- id: md2
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
### What happened
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-editing-page
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
##### `lowdefy.yaml`
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-add-blocks
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
Let's create a page for a form where users can log a new ticket.
|
||||
@ -106,7 +106,7 @@ _ref:
|
||||
content: Log a ticket
|
||||
level: 3
|
||||
- id: md3
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### Step 4
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-create-page
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
Lowdefy has a development server that allows you to develop your app locally. In this section we will start up the development server.
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-development-server
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### Step 1
|
||||
@ -50,7 +50,7 @@ _ref:
|
||||
|
||||
To save these changes, we are going to make a commit in the project repository.
|
||||
- id: md2
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
Write a message to describe the changes you have made, choose the option to create a new branch, and click "Propose changes". Then click "Create pull request".
|
||||
@ -83,7 +83,7 @@ _ref:
|
||||
properties:
|
||||
content: Hello World
|
||||
- id: md3
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### Step 6
|
||||
|
@ -21,7 +21,7 @@ _ref:
|
||||
# prefetchPages: []
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
We will be saving the data from our form in a Google Sheet, using the [`GoogleSheet`](\GoogleSheet). To do this, we will first need to set up a Google Cloud Platform project to get credentials to access the API.
|
||||
@ -96,7 +96,7 @@ _ref:
|
||||
message: By base64 encoding your credentials you have not encrypted them. They are still just as sensitive as before.
|
||||
|
||||
- id: md2
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### Step 12
|
||||
@ -117,7 +117,7 @@ _ref:
|
||||
showIcon: false
|
||||
message: The .env file contains your credentials. Do not commit this file to git. It should be listed in your .gitignore file if you started from the project template.
|
||||
- id: md3
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### Step 12
|
||||
@ -250,7 +250,7 @@ _ref:
|
||||
- id: submit_button
|
||||
type: Button
|
||||
#...
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: validate
|
||||
type: Validate
|
||||
|
@ -22,7 +22,7 @@ _ref:
|
||||
# - tutorial-editing-page
|
||||
content:
|
||||
- id: md1
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
In this tutorial we will be creating a simple ticketing app, that allow users to file new tickets, and see a list of outstanding tickets. We will be hosting this app with [Netlify](https://www.netlify.com).
|
||||
@ -57,7 +57,7 @@ _ref:
|
||||
showIcon: false
|
||||
message: If your repository isn't found, click "Configure Netlify on Github", and give Netlify access to your repository.
|
||||
- id: md2
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### Step 3
|
||||
@ -74,7 +74,7 @@ _ref:
|
||||
showIcon: false
|
||||
message: Your site won't work yet. You first need to configure the Lowdefy backend server in the next step.
|
||||
- id: md3
|
||||
type: MarkdownWithHtml
|
||||
type: MarkdownWithCode
|
||||
properties:
|
||||
content: |
|
||||
#### Step 4
|
||||
@ -138,7 +138,7 @@ _ref:
|
||||
properties:
|
||||
size: large
|
||||
title: Let's build something
|
||||
actions:
|
||||
events:
|
||||
onClick:
|
||||
- id: link_to_docs
|
||||
type: Link
|
||||
|
@ -22,10 +22,10 @@ import Requests from './Requests';
|
||||
import State from './State';
|
||||
|
||||
const blockData = ({
|
||||
actions,
|
||||
areas,
|
||||
blockId,
|
||||
blocks,
|
||||
events,
|
||||
field,
|
||||
id,
|
||||
layout,
|
||||
@ -39,10 +39,10 @@ const blockData = ({
|
||||
validate,
|
||||
visible,
|
||||
}) => ({
|
||||
actions,
|
||||
areas,
|
||||
blockId,
|
||||
blocks,
|
||||
events,
|
||||
field,
|
||||
id,
|
||||
layout,
|
||||
|
Loading…
Reference in New Issue
Block a user