Skip to content
This repository was archived by the owner on May 20, 2023. It is now read-only.

Commit 666b936

Browse files
phantomessenshahan
authored andcommitted
Move location of colons and use -- for attributes for modal docs.
PiperOrigin-RevId: 204409415
1 parent 02f9bdf commit 666b936

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

lib/laminate/components/modal/modal.dart

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import 'package:angular_components/utils/disposer/disposer.dart';
1616
///
1717
/// Creates a stack of modals, hiding the previous one when a new is shown.
1818
///
19-
/// __Example use__:
19+
/// __Example use:__
2020
/// bootstrap(MyApp, const [GlobalModalStack]);
2121
///
2222
/// **NOTE**: Usage of this removes [Modal]'s built in LIFO stack.
@@ -106,7 +106,7 @@ abstract class Modal {
106106
/// If [preventInteraction] is `true` (it is by default), interaction with the
107107
/// rest of the application may be disabled until the dialog is closed.
108108
///
109-
/// __Example usage__:
109+
/// __Example usage:__
110110
/// <!-- With aggressive content -->
111111
/// <modal [preventInteraction]="isModal" ([visible])="showDialog">
112112
/// Hello World!
@@ -119,15 +119,17 @@ abstract class Modal {
119119
/// </template>
120120
/// </modal>
121121
///
122-
/// __Events__:
123-
/// `open`: Fires whenever the modal is opening (before visibility).
124-
/// `close`: Fires whenever the modal is closing (before visibility).
125-
/// `visible`: Fires whenever visibility changes.
126-
/// `shieldClick`: Fires whenever the modal background is pressed.
122+
/// __Events:__
127123
///
128-
/// __Properties__:
129-
/// `preventInteraction`: Set to false to allow interaction with your app.
130-
/// `visible`: Set in order to change visibility. This will trigger an open
124+
/// - `open` -- Fires whenever the modal is opening (before visibility).
125+
/// - `visible` -- Fires whenever visibility changes.
126+
/// - `close` -- Fires whenever the modal is closing (before visibility).
127+
/// - `shieldClick` -- Fires whenever the modal background is pressed.
128+
///
129+
/// __Properties:__
130+
///
131+
/// - `preventInteraction` -- Set to false to allow interaction with your app.
132+
/// - `visible` -- Set in order to change visibility. This will trigger an open
131133
/// and close interaction cycle that allows users to cancel.
132134
@Component(
133135
selector: 'modal',

0 commit comments

Comments
 (0)