Skip to content

Commit cda9a74

Browse files
author
Christoph Erdmann
committed
fix some docs and typos
1 parent e5e6595 commit cda9a74

File tree

5 files changed

+13
-12
lines changed

5 files changed

+13
-12
lines changed

src/widgets/Collapsible.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@
1515
* Collapsibles are accordion elements that expand when clicked on. They allow you to hide content that is not immediately relevant to the user.
1616
*
1717
* Simply provide the [[items]] as an array.
18+
*
1819
* For each item you can define the `header` and `body` key for header and body configuration.
1920
* Both `header` and `body` support the following special options:
2021
* - `tag`: the tag for the container tag, defaults to `div`.
2122
* - `content`: the content for the respective section. This can be arbitrary HTML.
23+
*
2224
* All other options are rendered as HTML attributes.
2325
*
2426
* ```php
@@ -29,7 +31,7 @@
2931
* 'content' => '<i class="material-icons">filter_drama</i>First'
3032
* ],
3133
* 'body' => [
32-
* 'content' => '<span>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</span>',
34+
* 'content' => '<span>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</span>',
3335
* ],
3436
* ],
3537
* [
@@ -38,7 +40,7 @@
3840
* 'class' => 'customHeader',
3941
* ],
4042
* 'body' => [
41-
* 'content' => '<span>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</span>',
43+
* 'content' => '<span>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</span>',
4244
* 'tag' => 'p',
4345
* 'data-body-category' => 'example',
4446
* ],
@@ -48,7 +50,7 @@
4850
* @author Christoph Erdmann <[email protected]>
4951
* @package widgets
5052
*
51-
* @see http://materializecss.com/carousel.html
53+
* @see http://materializecss.com/collapsible.html
5254
*/
5355
class Collapsible extends BaseWidget
5456
{

src/widgets/form/TimePicker.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
* @author Christoph Erdmann <[email protected]>
1717
* @package widgets
1818
* @subpackage form
19+
* @see http://materializecss.com/forms.html#time-picker
1920
*/
2021
class TimePicker extends BaseInputWidget
2122
{
@@ -47,7 +48,7 @@ class TimePicker extends BaseInputWidget
4748
public $defaultValue = 'now';
4849

4950
/**
50-
* Initializes the widget.
51+
* Initialize the widget.
5152
*/
5253
public function init()
5354
{
@@ -73,8 +74,8 @@ public function init()
7374
}
7475

7576
/**
76-
* Executes the widget.
77-
* @return string the result of widget execution to be outputted.
77+
* Execute the widget.
78+
* @return string the result of widget execution to be outputted
7879
*/
7980
public function run()
8081
{

src/widgets/media/Carousel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
/**
1515
* Carousel is a robust and versatile component that can be an image slider or an item carousel with arbitrary HTML content.
1616
*
17-
* Simply provide the [[slides]] as an array of items.
17+
* Simply provide the [[items]] as an array of items.
1818
* For each item you must define the `image` key with the image's `src`. Additionally you can define and align a caption
1919
* for every slide individually. Caption content can be HTML and will <strong>not</strong> be encoded.
2020
*

src/widgets/navigation/FixedActionButton.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ class FixedActionButton extends BaseWidget
107107

108108
/**
109109
* @var array the options for the optional icon.
110-
* The icon will be rendered by [[Icon|Icon]].
110+
* The icon will be rendered by [[\macgyer\yii2materializecss\widgets\Icon|Icon]].
111111
*
112112
* To specify an icon you can use the following parameters:
113113
*

src/widgets/navigation/Nav.php

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
use macgyer\yii2materializecss\assets\MaterializeAsset;
1111
use macgyer\yii2materializecss\lib\BaseWidget;
1212
use macgyer\yii2materializecss\lib\Html;
13-
use macgyer\yii2materializecss\widgets\navigation\Dropdown;
14-
use macgyer\yii2materializecss\widgets\navigation\SideNav;
1513
use Yii;
1614
use yii\base\InvalidConfigException;
1715
use yii\helpers\ArrayHelper;
@@ -126,9 +124,9 @@ class Nav extends BaseWidget
126124

127125
/**
128126
* @var array the configuration options for the toggle button.
129-
* The toggle button is rendered by the [[Button]] widget. See the docs for all available options.
127+
* The toggle button is rendered by the [[\macgyer\yii2materializecss\widgets\Button|Button]] widget. See the docs for all available options.
130128
*
131-
* @see Button|Button
129+
* @see \macgyer\yii2materializecss\widgets\Button|Button
132130
*/
133131
public $sideNavToggleButtonOptions = [];
134132

0 commit comments

Comments
 (0)