Skip to content

Conversation

@gfontorbe
Copy link
Contributor

This part of the documentation aim at describing the main components of Sprotty.

They are not meant to give specific implementation tutorials or extensive reference. These parts will come in future PRs.

@gfontorbe gfontorbe requested review from jbicker and spoenemann July 25, 2025 08:08
Copy link
Contributor

@spoenemann spoenemann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great content! 👏

But the GitHub action needs to be updated: https://github.com/eclipse-sprotty/sprotty-website/actions/runs/16517141406/job/46710317484?pr=41

@jbicker jbicker force-pushed the gfontorbe/more-documentation branch 3 times, most recently from 321926e to 73b3547 Compare July 29, 2025 13:57
@jbicker jbicker force-pushed the gfontorbe/more-documentation branch from 73b3547 to 0933fc4 Compare July 29, 2025 14:01
gfontorbe and others added 2 commits August 1, 2025 07:34
Co-authored-by: Miro Spönemann <miro.spoenemann@typefox.io>
Co-authored-by: Miro Spönemann <miro.spoenemann@typefox.io>
Copy link
Contributor

@jbicker jbicker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, great content! Thanks for that.
One or two sentences about mergable commands would be great.
And please search for relative links where you've used ref and use relref instead.


Sprotty also offers the ability to attach mouse and keyboard listeners by registering `MouseListener` or `KeyListener`.
This can be simply done by binding the custom listener to the respective listener type in your [DI-container]({{< ref "/docs/recipes/dependency-injection" >}}) like this:
This can be simply done by binding the custom listener to the respective listener type in your [DI-container]({{< ref "/docs/concepts/extension-points">}}#dependency-injection) like this:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like above use relref here

* `type: string`: The type of the element. This value is used in the Sprotty configuration to specify the corresponding view for all elements of this type.
* `id: string`: The globally unique identifier of the element.
* `features: FeatureSet` - *optional*: A set of [features]({{< ref "/docs/ref/features" >}}) that are enabled on the element. The list of features can be further configured in the [dependency injection container]({{< ref "/docs/recipes/dependency-injection" >}}#features).
* `features: FeatureSet` - *optional*: A set of [features]({{< ref "/docs/ref/features" >}}) that are enabled on the element. The list of features can be further configured in the [dependency injection container]({{< ref "/docs/concepts/extension-points">}}#dependency-injection).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use relref

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is removed in later PR

@gfontorbe gfontorbe merged commit bb7171f into main Aug 28, 2025
3 of 4 checks passed
@github-actions
Copy link

PR Preview Action v1.6.2
Preview removed because the pull request was closed.
2025-08-28 13:20 UTC

@gfontorbe gfontorbe deleted the gfontorbe/more-documentation branch September 22, 2025 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants