From bec0d9c67898d6e1a2001bb01b94381d1b04777e Mon Sep 17 00:00:00 2001 From: bnznamco Date: Wed, 24 Jan 2024 12:10:10 +0100 Subject: [PATCH] docs: update docs --- docs/Changelog/README.md | 20 +++++++++ docs/components/Detail/Detail/README.md | 2 + .../Form/fields/mapField/MapField/README.md | 41 +++++++++++++++++++ docs/components/PagePreview/README.md | 13 ++++++ 4 files changed, 76 insertions(+) create mode 100644 docs/components/Form/fields/mapField/MapField/README.md create mode 100644 docs/components/PagePreview/README.md diff --git a/docs/Changelog/README.md b/docs/Changelog/README.md index ffdb6fc8..31f1b70e 100644 --- a/docs/Changelog/README.md +++ b/docs/Changelog/README.md @@ -3,6 +3,26 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.0.0-alpha.50](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.49...v1.0.0-alpha.50) (2024-01-24) + + +### Bug Fixes + +* **listexample:** fixed field declaration ([0baa347](https://github.com/lotrekagency/mapo/commit/0baa347236b2afc8a1bb7104374317d7dd400f27)) +* **listexample:** removed duplicated field. Fixed typo ([22858ba](https://github.com/lotrekagency/mapo/commit/22858bad52646b51dc6bfad01dba72a566d46cfd)) + + +### Features + +* added MapField ([3ba3b26](https://github.com/lotrekagency/mapo/commit/3ba3b262120a543f187ee4a5e9f24d31a7a1e1b4)) +* **Detail:** added PagePreview component ([9ed8975](https://github.com/lotrekagency/mapo/commit/9ed8975ba60a5954abe985a0565a198ea7f62aad)) +* **fields:** added geo point field ([ba0dd0c](https://github.com/lotrekagency/mapo/commit/ba0dd0c782524914826941b2cbdf7b4169a35afe)) +* **Time and DateTime:** added Ok button to close menu ([11f1d1e](https://github.com/lotrekagency/mapo/commit/11f1d1e52e45d154a064eb545e2812a0c8cf1f7b)) + + + + + # [1.0.0-alpha.49](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.48...v1.0.0-alpha.49) (2023-07-27) diff --git a/docs/components/Detail/Detail/README.md b/docs/components/Detail/Detail/README.md index 1c346202..cb5eefe4 100644 --- a/docs/components/Detail/Detail/README.md +++ b/docs/components/Detail/Detail/README.md @@ -20,6 +20,7 @@ The purpose of this component is to provide you with a very quick way to create |modelName|The title of the detail page.|`String`|`false`|-| |sticky|This determines the style of the sidebar. If set to true the sidebar will remain sticky during the scroll.|`Boolean`|`false`|true| |multipart|Set the multipart politic. Accepts `'auto'|'force|'disable'`. If auto is set the request is transformed in multipart if any file is in the payload. If set to force the request is transformed in multipart no matter if files are found. If set to `'disable'` the request is never transformed in multipart.|`String`|`false`|auto| +|previewField|The name of the field that contains the url of the page preview. [optional]|`String`|`false`|-| |readonly|This forces the detail page to be readonly.|`Boolean`|`false`|-| @@ -54,6 +55,7 @@ The purpose of this component is to provide you with a very quick way to create |button.savecontinue|Use this to override the Save and continue button.|The Save and continue button.| |button.back|Use this to override the Back button.|The Back button.| |button.delete|Use this to override the Delete button.|The Delete button.| +|button.preview|Use this to override the Preview Page button.|The Preview Page button. Needs a preview field from model. Declare it in the props.| |side.top|Use this to add content on the top of the sidebar fields (or under sidebar buttons).|-| |side.bottom|Use this to add content under the sidebar fields.|-| diff --git a/docs/components/Form/fields/mapField/MapField/README.md b/docs/components/Form/fields/mapField/MapField/README.md new file mode 100644 index 00000000..e02d62c3 --- /dev/null +++ b/docs/components/Form/fields/mapField/MapField/README.md @@ -0,0 +1,41 @@ +# MapField + +## Props + + + +|Name|Description|Type|Required|Default| +|---|---|---|---|---| +|value|V-model property.|`Array`|`false`|-| +|label|This label will be shown at the top of the editor.|`String`|`false`|-| +|readonly|This set the component status to readonly, stopping the user interaction.|`Boolean`|`false`|false| +|multiple|This set the component status to multiple, allowing the user to add multiple points. Pass it into attrs|`Boolean`|`false`|false| +|fields|-|[`Array`](/components/Detail/Detail/#fieldconfiguration)|`false`|[]| +|errorMessages|Puts the input in an error state and passes through custom error messages.|`Array`|`false`|[]| + + + + +## Events + + + +|Event Name|Description|Parameters| +|---|---|---| +|input|-|-| + + + + +## Slots + + + +|Name|Description|Default Slot Content| +|---|---|---| +|name|-|-| +|name|-|-| + + + + diff --git a/docs/components/PagePreview/README.md b/docs/components/PagePreview/README.md new file mode 100644 index 00000000..b2fc095e --- /dev/null +++ b/docs/components/PagePreview/README.md @@ -0,0 +1,13 @@ +# PagePreview + +## Props + + + +|Name|Description|Type|Required|Default| +|---|---|---|---|---| +|pageUrl|-|`String`|`false`|-| + + + +