Skip to content

[WIP] Update README with context type descriptions #7442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[WIP] Update README with context type descriptions #7442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions 16/umbraco-cms/customizing/foundation/contexts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,33 @@
## [Property Dataset Context](property-dataset-context.md)

A Dataset Context is the connection point between a Property Editor and a Workspace and covers a set of properties.

## Current User Context

## Section Context

## Workspace Context

## Property Context

The data regarding the specific property

## Modal Context

Available for a Modal, read the parsed data, submit/close and send a value back

## Entity Context

Holds simple-dataset on the Entity, available for Tree Items or Picked Items, so when not in a Workspace this is where you get some information.

Check warning on line 33 in 16/umbraco-cms/customizing/foundation/contexts/README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.Editorializing] Consider removing 'simple' as it can be considered opinionated.

Raw Output:
{"message": "[UmbracoDocs.Editorializing] Consider removing 'simple' as it can be considered opinionated.", "location": {"path": "16/umbraco-cms/customizing/foundation/contexts/README.md", "range": {"start": {"line": 33, "column": 7}}}, "severity": "WARNING"}

Check warning on line 33 in 16/umbraco-cms/customizing/foundation/contexts/README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.", "location": {"path": "16/umbraco-cms/customizing/foundation/contexts/README.md", "range": {"start": {"line": 33, "column": 1}}}, "severity": "WARNING"}

## App Language Context

Knowledge on the Culture of the Application, the dropdown in the top of the Content-Section Sidebar

## Workspace Split View Context

Relevant when working with Split View.

## Block Entry Context

Holds the data for a Block, this is available for Block Custom Views. Notice Block Custom View Elements does get most information via Properties assigned, but if you like to do some editing or advanced stuff then this is available.

Check warning on line 45 in 16/umbraco-cms/customizing/foundation/contexts/README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.", "location": {"path": "16/umbraco-cms/customizing/foundation/contexts/README.md", "range": {"start": {"line": 45, "column": 71}}}, "severity": "WARNING"}
Loading