Skip to content

Commit

Permalink
update component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcolarosa committed Apr 16, 2024
1 parent deb2ebd commit 742b355
Showing 1 changed file with 28 additions and 25 deletions.
53 changes: 28 additions & 25 deletions src/docs/component/usage-and-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,14 @@ Pass in the crate file and optionally a profile.
:enable-template-save="true"
:enable-internal-routing="true"
:enable-reverse-link-browser="true"
:enable-url-markup="true"
:purge-unlinked-entities="true"
:readonly="false"
:webcomponent="false"
:tabLocation="'left'"
:resetTabOnEntityChange="true"
:resetTabOnProfileChange="true"
:showControls="true"
:web-component="false"
:tab-location="'left'"
:reset-tab-on-entity-change="true"
:reset-tab-on-profile-change="true"
:show-controls="true"
@ready="ready"
@error="handleErrors"
@warning="handleWarnings"
Expand Down Expand Up @@ -125,29 +126,31 @@ for an example. In fact, you probably want to start from there.
control
- `enable-template-save`: true | false: `(default: false)` : enable / disable the entity and crate
template saving controls
- `enableInternalRouting`: true | false: `(default: false)`: enable / disable the internal router
which updates the location whenever an entity is selected. If no router is found (ie inside a
web component or just not used), routing is turned off anyway. Most likely you want to leave the
component to deal with this or listen out for the `navigation` event and handle it yourself if
the component can't.
- `enableReverseLinkBrowser`: true : false: `(default: true)`: enable / disable the reverse link
browser. If enabled, it can be shown as a right sidebar as required.
- `purgeUnlinkedEntities`: true : false: `(default: true)`: purge unlinked entities from the crate
before emitting the crate for saving
- `enable-internal-routing`: true | false: `(default: false)`: enable / disable the internal
router which updates the location whenever an entity is selected. If no router is found (ie
inside a web component or just not used), routing is turned off anyway. Most likely you want to
leave the component to deal with this or listen out for the `navigation` event and handle it
yourself if the component can't.
- `enable-reverse-link-browser`: true : false: `(default: true)`: enable / disable the reverse
link browser. If enabled, it can be shown as a right sidebar as required.
- `enable-url-markup`: true : false: `(default: true)`: When describo detects that a string is a
URL, it will store an entity of type URL in the crate. If you would rather just have these as
strings, set this to false (note that the URL primitive still outputs a URL entity)
- `purge-unlinked-entities`: true : false: `(default: true)`: purge unlinked entities from the
crate before emitting the crate for saving
- `readonly`: true | false: `(default: false)` : if set to true all of the controls to edit that
the data are turned off. The crate is set into a mode where it is readonly.
- `webComponent`: true | false: `(default: false)` : Setting this to true alters the behaviour of
- `web-component`: true | false: `(default: false)` : Setting this to true alters the behaviour of
some components when the crate builder is used as a web component.
- `tabLocation`: left | top | right | bottom: `(default: left)` : Specify where the tabs are shown
when profiles define grouping.
- `resetTabOnEntityChange`: true | false: `(default: true)` : When true, if a layout is applied
and the entity changes, the UI will navigate to the about tab. If false, that doesn't happen.
- `resetTabOnProfileChange`: true | false: `(default: true)` : When true, if a layout is applied
and the profile changes, the UI will navigate to the about tab. If false, that doesn't happen if
there is a matching tab. Otherwise it will go back to the about tab.
- `showControls`: true | false: `(default: true)` : Show or hide the controls bar. Useful if you
want to provision those controls in your own application.
- `showControls`: true | false: `(default: true)` : Show or hide the controls bar. Useful if you
- `tab-location`: left | top | right | bottom: `(default: left)` : Specify where the tabs are
shown when profiles define grouping.
- `reset-tab-on-entity-change`: true | false: `(default: true)` : When true, if a layout is
applied and the entity changes, the UI will navigate to the about tab. If false, that doesn't
happen.
- `reset-tab-on-profile-change`: true | false: `(default: true)` : When true, if a layout is
applied and the profile changes, the UI will navigate to the about tab. If false, that doesn't
happen if there is a matching tab. Otherwise it will go back to the about tab.
- `show-controls`: true | false: `(default: true)` : Show or hide the controls bar. Useful if you
want to provision those controls in your own application.
- `language`: en | hu `(default: en)` : Sets the component's localization to the given language.
Currently English (en) and Hungarian (hu) are supported.
Expand Down

0 comments on commit 742b355

Please sign in to comment.