Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bnznamco committed Jan 24, 2024
1 parent f98d383 commit bec0d9c
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/Changelog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand Down
2 changes: 2 additions & 0 deletions docs/components/Detail/Detail/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`|-|

<!-- @vuese:Detail:props:end -->
Expand Down Expand Up @@ -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.|-|

Expand Down
41 changes: 41 additions & 0 deletions docs/components/Form/fields/mapField/MapField/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# MapField

## Props

<!-- @vuese:MapField:props:start -->

|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<FieldConfiguration>`](/components/Detail/Detail/#fieldconfiguration)|`false`|[]|
|errorMessages|Puts the input in an error state and passes through custom error messages.|`Array`|`false`|[]|

<!-- @vuese:MapField:props:end -->


## Events

<!-- @vuese:MapField:events:start -->

|Event Name|Description|Parameters|
|---|---|---|
|input|-|-|

<!-- @vuese:MapField:events:end -->


## Slots

<!-- @vuese:MapField:slots:start -->

|Name|Description|Default Slot Content|
|---|---|---|
|name|-|-|
|name|-|-|

<!-- @vuese:MapField:slots:end -->


13 changes: 13 additions & 0 deletions docs/components/PagePreview/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# PagePreview

## Props

<!-- @vuese:PagePreview:props:start -->

|Name|Description|Type|Required|Default|
|---|---|---|---|---|
|pageUrl|-|`String`|`false`|-|

<!-- @vuese:PagePreview:props:end -->


0 comments on commit bec0d9c

Please sign in to comment.