docs: LSDV-5343: Docs for visibleWhen; remove FF_DEV_1372 (#4443)

* [submodules] Build static heartexlabs/label-studio-frontend Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5379017878 * docs: LSF Update Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5379017878 * [submodules] Build static heartexlabs/label-studio-frontend Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5379047192 * [submodules] Build static heartexlabs/label-studio-frontend Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5383223119 * [submodules] Build static heartexlabs/label-studio-frontend Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5383578965 * [submodules] Build static heartexlabs/label-studio-frontend Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5423103898 * [submodules] Build static heartexlabs/label-studio-frontend Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5423889083 * [submodules] Build static heartexlabs/label-studio-frontend Workflow run: https://github.com/heartexlabs/label-studio/actions/runs/5449814349 * [submodules] Build static HumanSignal/label-studio-frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/5880811896 * [submodules] Build static HumanSignal/label-studio-frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/5890902627 * docs: LSF Update Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/5890902627 --------- Co-authored-by: hlomzik <[email protected]> Co-authored-by: hlomzik <[email protected]>
HumanSignal · Aug 17, 2023 · a98ce86 · a98ce86
1 parent d7b6bbc
commit a98ce86
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/docs/source/tags/choices.md b/docs/source/tags/choices.md
@@ -28,10 +28,10 @@ The `Choices` tag can be used with any data types.
 | [showInline] | <code>boolean</code> | <code>false</code> | Show choices in the same visual line |
 | [required] | <code>boolean</code> | <code>false</code> | Validate whether a choice has been selected |
 | [requiredMessage] | <code>string</code> |  | Show a message if validation fails |
-| [visibleWhen] | <code>region-selected</code> \| <code>choice-selected</code> \| <code>no-region-selected</code> |  | Control visibility of the choices. |
+| [visibleWhen] | <code>region-selected</code> \| <code>no-region-selected</code> \| <code>choice-selected</code> \| <code>choice-unselected</code> |  | Control visibility of the choices. Can also be used with `when*` attributes below to narrow down visibility |
 | [whenTagName] | <code>string</code> |  | Use with visibleWhen. Narrow down visibility by name of the tag. For regions, use the name of the object tag, for choices, use the name of the choices tag |
-| [whenLabelValue] | <code>string</code> |  | Narrow down visibility by label value |
-| [whenChoiceValue] | <code>string</code> |  | Narrow down visibility by choice value |
+| [whenLabelValue] | <code>string</code> |  | Use with visibleWhen="region-selected". Narrow down visibility by label value |
+| [whenChoiceValue] | <code>string</code> |  | Use with visibleWhen ("choice-selected" or "choice-unselected") and whenTagName, both are required. Narrow down visibility by choice value |
 | [perRegion] | <code>boolean</code> |  | Use this tag to select a choice for a specific region instead of the entire task |
 | [perItem] | <code>boolean</code> |  | Use this tag to select a choice for a specific item inside the object instead of the whole object[^1] |
 | [value] | <code>string</code> |  | Task data field containing a list of dynamically loaded choices (see example below)[^2] |

diff --git a/docs/source/tags/view.md b/docs/source/tags/view.md
@@ -15,10 +15,10 @@ The `View` element is used to configure the display of blocks, similar to the di
 | display | <code>block</code> \| <code>inline</code> |  |
 | [style] | <code>string</code> | CSS style string |
 | [className] | <code>string</code> | Class name of the CSS style to apply. Use with the Style tag |
-| [visibleWhen] | <code>region-selected</code> \| <code>choice-selected</code> \| <code>no-region-selected</code> | Show the contents of a view when condition is true |
-| [whenTagName] | <code>string</code> | Narrow down visibility by tag name. For regions, use the name of the object tag, for choices, use the name of the choices tag. |
-| [whenLabelValue] | <code>string</code> | Narrow down visibility by label value |
-| [whenChoiceValue] | <code>string</code> | Narrow down visibility by choice value |
+| [visibleWhen] | <code>region-selected</code> \| <code>choice-selected</code> \| <code>no-region-selected</code> \| <code>choice-unselected</code> | Control visibility of the content. Can also be used with `when*` attributes below to narrow down visibility |
+| [whenTagName] | <code>string</code> | Use with visibleWhen. Narrow down visibility by tag name. For regions, use the name of the object tag, for choices, use the name of the choices tag |
+| [whenLabelValue] | <code>string</code> | Use with visibleWhen="region-selected". Narrow down visibility by label value |
+| [whenChoiceValue] | <code>string</code> | Use with visibleWhen ("choice-selected" or "choice-unselected") and whenTagName, both are required. Narrow down visibility by choice value |
 
 ### Example
 

diff --git a/label_studio/frontend/dist/lsf/js/main.js b/label_studio/frontend/dist/lsf/js/main.js
diff --git a/label_studio/frontend/dist/lsf/js/main.js.map b/label_studio/frontend/dist/lsf/js/main.js.map
diff --git a/label_studio/frontend/dist/lsf/version.json b/label_studio/frontend/dist/lsf/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "chore: OPTIC-4: Remove any profanity from sample data",
-  "commit": "41ae765ba05e11414ff262f7aa6454c186ac4145",
+  "message": "docs: LSDV-5343: Docs for visibleWhen; remove FF_DEV_1372",
+  "commit": "36b729ab5cab84fb75fa897b75d7277cb49262da",
   "branch": "master",
-  "date": "2023/08/16 21:50:21"
+  "date": "2023/08/17 13:30:10"
 }