Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

Commit 8ae9c03

Browse files
bryanridesharkkara
authored andcommitted
docs(panel): fix casing and add clarity to documentation on mdPanelRef (#10502)
1 parent 29ef510 commit 8ae9c03

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/components/panel/panel.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ angular
111111
* }
112112
*
113113
* function PanelMenuCtrl(mdPanelRef) {
114+
* // The controller is provided with an import named 'mdPanelRef'
114115
* this.closeMenu = function() {
115116
* mdPanelRef && mdPanelRef.close();
116117
* };
@@ -235,7 +236,8 @@ angular
235236
* - `locals` - `{Object=}`: An object containing key/value pairs. The keys
236237
* will be used as names of values to inject into the controller. For
237238
* example, `locals: {three: 3}` would inject `three` into the controller,
238-
* with the value 3.
239+
* with the value 3. 'mdPanelRef' is a reserved key, and will always
240+
* be set to the created MdPanelRef instance.
239241
* - `resolve` - `{Object=}`: Similar to locals, except it takes promises as
240242
* values. The panel will not open until all of the promises resolve.
241243
* - `attachTo` - `{(string|!angular.JQLite|!Element)=}`: The element to

0 commit comments

Comments
 (0)