Searchbox: deprecate defaultValue (#4225)

* Deprecate SearchBox defaultValue prop. * npm run change output
microsoft · Mar 27, 2018 · 7bed353 · 7bed353
1 parent 6325dee
commit 7bed353
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/...on/changes/office-ui-fabric-react/searchbox--deprecate-defaultValue_2018-03-09-20-24.json b/...on/changes/office-ui-fabric-react/searchbox--deprecate-defaultValue_2018-03-09-20-24.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "office-ui-fabric-react",
+      "comment": "Deprecate SearchBox defaultValue prop.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "office-ui-fabric-react",
+  "email": "[email protected]"
+}
diff --git a/packages/office-ui-fabric-react/src/components/SearchBox/SearchBox.base.tsx b/packages/office-ui-fabric-react/src/components/SearchBox/SearchBox.base.tsx
@@ -30,7 +30,8 @@ export class SearchBoxBase extends BaseComponent<ISearchBoxProps, ISearchBoxStat
     super(props);
 
     this._warnDeprecations({
-      'labelText': 'placeholder'
+      'labelText': 'placeholder',
+      'defaultValue': 'value'
     });
 
     this._latestValue = props.value || '';

diff --git a/packages/office-ui-fabric-react/src/components/SearchBox/SearchBox.types.ts b/packages/office-ui-fabric-react/src/components/SearchBox/SearchBox.types.ts
@@ -66,6 +66,9 @@ export interface ISearchBoxProps extends React.InputHTMLAttributes<HTMLInputElem
 
   /**
    * The default value of the text in the SearchBox, in the case of an uncontrolled component.
+   * Up till now, this has not been implemented, deprecating. Will re-implement if uncontrolled
+   * component behavior is implemented.
+   * @deprecated
    */
   defaultValue?: string;