chore: make boolean props false by default (#409)

SAP · May 20, 2019 · 9c243f9 · 9c243f9
1 parent 650bcb0
commit 9c243f9
Show file tree

Hide file tree

Showing 26 changed files with 165 additions and 4 deletions.
diff --git a/packages/base/src/State.js b/packages/base/src/State.js
@@ -30,7 +30,8 @@ class State {
 					if (typeof this._data[prop] !== "undefined") {
 						return this._data[prop];
 					}
-					if (propData.type === "boolean") {
+
+					if (propData.type === "boolean" || propData.type === Boolean) {
 						return false;
 					} else if (propData.multiple) { // eslint-disable-line
 						return [];

diff --git a/packages/main/src/Button.js b/packages/main/src/Button.js
@@ -92,6 +92,7 @@ const metadata = {
 		 * <code>import InputElementsFormSupport from "@ui5/webcomponents/dist/InputElementsFormSupport";</code>
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		submits: {

diff --git a/packages/main/src/DatePicker.js b/packages/main/src/DatePicker.js
@@ -87,6 +87,7 @@ const metadata = {
 		 * Determines whether the <code>ui5-datepicker</code> is displayed as disabled.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		disabled: {
@@ -97,6 +98,7 @@ const metadata = {
 		 * Determines whether the <code>ui5-datepicker</code> is displayed as readonly.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		readonly: {

diff --git a/packages/main/src/Dialog.js b/packages/main/src/Dialog.js
@@ -24,6 +24,7 @@ const metadata = {
 		 * 90% of the viewport.
 		 *
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		stretch: {

diff --git a/packages/main/src/Input.js b/packages/main/src/Input.js
@@ -70,6 +70,7 @@ const metadata = {
 		 * <b>Note:</b> A disabled <code>ui5-input</code> is completely uninteractive.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		disabled: {
@@ -96,6 +97,7 @@ const metadata = {
 		 * but still provides visual feedback upon user interaction.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		readonly: {
@@ -169,6 +171,7 @@ const metadata = {
 		 * Defines whether the <code>ui5-input</code> should show suggestions, if such are present.
 		 *
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		showSuggestions: {

diff --git a/packages/main/src/Label.js b/packages/main/src/Label.js
@@ -25,6 +25,7 @@ const metadata = {
 		 * <b>Note:</b> Usually indicates that user input is required.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		required: {
@@ -37,6 +38,7 @@ const metadata = {
 		 * <b>Note:</b> By default the text would truncate.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		wrap: {

diff --git a/packages/main/src/Link.js b/packages/main/src/Link.js
@@ -28,6 +28,7 @@ const metadata = {
 		 * <b>Note:</b> When disabled, the link cannot be triggered by the user.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		disabled: {
@@ -84,6 +85,7 @@ const metadata = {
 		 * <b>Note:</b> the text is truncated by default.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		wrap: {

diff --git a/packages/main/src/List.js b/packages/main/src/List.js
@@ -82,6 +82,7 @@ const metadata = {
 		 * Determines whether the list items are indented.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		inset: {
@@ -95,6 +96,7 @@ const metadata = {
 		 * <code>MultiSelect</code>, and <code>Delete</code>.
 		 *
 		 * @type {string}
+		 * @defaultvalue "None"
 		 * @public
 		 */
 		mode: {
@@ -125,6 +127,7 @@ const metadata = {
 		 * </ul>
 		 *
 		 * @type {string}
+		 * @defaultvalue "All"
 		 * @public
 		 */
 		separators: {

diff --git a/packages/main/src/ListItem.js b/packages/main/src/ListItem.js
@@ -20,6 +20,7 @@ const metadata = {
 		/**
 		 * Defines the selected state of the <code>ListItem</code>.
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		selected: {
@@ -34,6 +35,7 @@ const metadata = {
 		 * while with type <code>Inactive</code> - will not.
 		 *
 		 * @type {string}
+		 * @defaultvalue "Active"
 		 * @public
 		*/
 		type: {

diff --git a/packages/main/src/Panel.js b/packages/main/src/Panel.js
@@ -71,6 +71,7 @@ const metadata = {
 		 * expandable/collapsible by user interaction.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		fixed: {
@@ -81,6 +82,7 @@ const metadata = {
 		 * Indicates whether the <code>ui5-panel</code> is collapsed and only the header is displayed.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		collapsed: {

diff --git a/packages/main/src/Popover.js b/packages/main/src/Popover.js
@@ -29,6 +29,7 @@ const metadata = {
 		 * Determines on which side the <code>ui5-popover</code> is placed at.
 		 *
 		 * @type {PopoverPlacementType}
+		 * @defaultvalue "Right"
 		 * @public
 		 */
 		placementType: {
@@ -40,6 +41,7 @@ const metadata = {
 		 * Determines the horizontal alignment of the <code>ui5-popover</code>.
 		 *
 		 * @type {PopoverHorizontalAlign}
+		 * @defaultvalue "Center"
 		 * @public
 		 */
 		horizontalAlign: {
@@ -51,6 +53,7 @@ const metadata = {
 		 * Determines the vertical alignment of the <code>ui5-popover</code>.
 		 *
 		 * @type {PopoverVerticalAlign}
+		 * @defaultvalue "Center"
 		 * @public
 		 */
 		verticalAlign: {
@@ -64,6 +67,7 @@ const metadata = {
 		 * If enabled, it blocks any interaction with the background.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		modal: {
@@ -74,6 +78,7 @@ const metadata = {
 		 * Determines whether the <code>ui5-popover</code> arrow is hidden.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		hideArrow: {
@@ -84,6 +89,7 @@ const metadata = {
 		 * Determines whether the <code>ui5-popover</code> would close upon user scroll.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		stayOpenOnScroll: {
@@ -95,6 +101,7 @@ const metadata = {
 		 * over the target.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		allowTargetOverlap: {

diff --git a/packages/main/src/Popup.js b/packages/main/src/Popup.js
@@ -65,6 +65,7 @@ const metadata = {
 		 * Defines whether the header is hidden.
 		 *
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		hideHeader: {

diff --git a/packages/main/src/RadioButton.js b/packages/main/src/RadioButton.js
@@ -34,6 +34,7 @@ const metadata = {
 		 * <b>Note:</b> A disabled <code>ui5-radiobutton</code> is completely uninteractive.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		disabled: {
@@ -47,6 +48,7 @@ const metadata = {
 		 * but still provides visual feedback upon user interaction.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		readOnly: {
@@ -61,6 +63,7 @@ const metadata = {
 		 * or by using the Space or Enter key.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		selected: {
@@ -87,6 +90,7 @@ const metadata = {
 		 * the <code>ui5-radiobutton</code>.
 		 *
 		 * @type {string}
+		 * @defaultvalue "None"
 		 * @public
 		 */
 		valueState: {

diff --git a/packages/main/src/Select.js b/packages/main/src/Select.js
@@ -54,6 +54,7 @@ const metadata = {
 		 * <b>Note:</b> A disabled <code>ui5-select</code> is noninteractive.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		disabled: {
@@ -66,6 +67,7 @@ const metadata = {
 		 * Available options are: <code>None</code>, <code>Success</code>, <code>Warning</code> and <code>Error</code>.
 		 *
 		 * @type {string}
+		 * @defaultvalue "None"
 		 * @public
 		 */
 		valueState: {

diff --git a/packages/main/src/ShellBar.js b/packages/main/src/ShellBar.js
@@ -93,6 +93,7 @@ const metadata = {
 		/**
 		 * Defines, if the product switch icon would be displayed.
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		showProductSwitch: {
@@ -102,6 +103,7 @@ const metadata = {
 		/**
 		 * Defines, if the product CoPilot icon would be displayed.
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		showCoPilot: {

diff --git a/packages/main/src/StandardListItem.js b/packages/main/src/StandardListItem.js
@@ -50,6 +50,7 @@ const metadata = {
 		 * <b>Note:</b> If <code>image</code> is set, the <code>icon</code> would be displayed after the <code>image</code>.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		iconEnd: {

diff --git a/packages/main/src/Switch.js b/packages/main/src/Switch.js
@@ -28,7 +28,7 @@ const metadata = {
 		 * pressing the <code>Enter</code> or <code>Space</code> key.
 		 *
 		 * @type {boolean}
-		 * @default false
+		 * @defaultvalue false
 		 * @public
 		 */
 		checked: {
@@ -41,7 +41,7 @@ const metadata = {
 		 * <b>Note:</b> A disabled <code>ui5-switch</code> is noninteractive.
 		 *
 		 * @type {boolean}
-		 * @default false
+		 * @defaultvalue false
 		 * @public
 		 */
 		disabled: {
@@ -83,7 +83,7 @@ const metadata = {
 		 * <b>Note:</b> If <code>Graphical</code> type is set,
 		 * positive and negative icons will replace the <code>textOn</code> and <code>textOff</code>.
 		 * @type {string}
-		 * @default Textual
+		 * @defaultvalue "Textual"
 		 * @public
 		 */
 		type: {

diff --git a/packages/main/src/Tab.js b/packages/main/src/Tab.js
@@ -44,6 +44,7 @@ const metadata = {
 		/**
 		 * Enabled items can be selected.
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		disabled: {
@@ -80,13 +81,21 @@ const metadata = {
 		 * Instead of the semantic icon color the brand color can be used, this is named Default.
 		 * Semantic colors and brand colors should not be mixed up inside one IconTabBar.
 		 * @type {IconColor}
+		 * @defaultvalue "Default"
 		 * @public
 		 */
 		iconColor: {
 			type: IconColor,
 			defaultValue: IconColor.Default,
 		},
 
+		/**
+		 * Specifies if the <code>ui5-tab</code> is selected.
+		 *
+		 * @type {Boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
 		selected: {
 			type: Boolean,
 			defaultValue: false,

diff --git a/packages/main/src/TabContainer.js b/packages/main/src/TabContainer.js
@@ -48,6 +48,7 @@ const metadata = {
 		 * expandable/collapsible by user interaction.
 		 *
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		fixed: {
@@ -58,6 +59,7 @@ const metadata = {
 		 * Determines whether the tab content is collapsed.
 		 *
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		collapsed: {
@@ -71,6 +73,7 @@ const metadata = {
 		 * so that it's easier for the user to select a specific tab filter.
 		 *
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		showOverflow: {

diff --git a/packages/main/src/Table.js b/packages/main/src/Table.js
@@ -68,6 +68,7 @@ const metadata = {
 		 * </ul>
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		stickyColumnHeader: {

diff --git a/packages/main/src/TableColumn.js b/packages/main/src/TableColumn.js
@@ -61,6 +61,7 @@ const metadata = {
 		 * Setting this property to <code>true</code>, shows this column as pop-in instead of hiding it.
 		 *
 		 * @type {boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		demandPopin: {

diff --git a/packages/main/src/TimelineItem.js b/packages/main/src/TimelineItem.js
@@ -63,6 +63,7 @@ const metadata = {
 		 * Defines whether the name is clickable.
 		 *
 		 * @type {Boolean}
+		 * @defaultvalue false
 		 * @public
 		 */
 		itemNameClickable: {