Skip to content

All: Document deep option getter/setter #235

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

Closed
wants to merge 1 commit into from
Closed

All: Document deep option getter/setter #235

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
10 changes: 8 additions & 2 deletions includes/widget-method-option.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@
Sets one or more options for the <placeholder name="name"/>.
</desc>
<signature return="Object" example-return-var="isDisabled" example-params='"disabled"'>
<desc>Gets the value currently associated with the specified <code>optionName</code>.</desc>
<desc>
<p>Gets the value currently associated with the specified <code>optionName</code>.</p>
<p><strong>Note:</strong> For options that have objects as their value, you can get the value of a specific key by using dot notation, e.g., <code>"foo.bar"</code> would get the value of the <code>bar</code> property on the <code>foo</code> option.</p>
</desc>
<argument name="optionName" type="String">
<desc>The name of the option to get.</desc>
</argument>
Expand All @@ -13,7 +16,10 @@
<desc>Gets an object containing key/value pairs representing the current <placeholder name="name"/> options hash.</desc>
</signature>
<signature example-params='"disabled", true'>
<desc>Sets the value of the <placeholder name="name"/> option associated with the specified <code>optionName</code>.</desc>
<desc>
<p>Sets the value of the <placeholder name="name"/> option associated with the specified <code>optionName</code>.</p>
<p><strong>Note:</strong> For options that have objects as their value, you can set the value of just one property by using dot notation for <code>optionName</code>, e.g., <code>"foo.bar"</code> would update only the <code>bar</code> property of the <code>foo</code> option.</p>
</desc>
<argument name="optionName" type="String">
<desc>The name of the option to set.</desc>
</argument>
Expand Down