From 7de7d945a39c307d01855e9578dd5a2791fcda4a Mon Sep 17 00:00:00 2001
From: Benjamin Charity <ben@benjamincharity.com>
Date: Thu, 6 Jun 2019 08:59:03 -0400
Subject: [PATCH] docs(Select): update migration notes for v13 [skip ci]

---
 CHANGELOG.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 62 insertions(+), 5 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d6fa85c5c..3a9f4d89e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,13 +1,70 @@
+
 ## 13.0.0 (2019-06-05)
 
-* fix(Select): split autocomplete and select into seperate components ([8f81e2d](https://github.com/GetTerminus/terminus-ui/commit/8f81e2d))
-* 1444 split select & autocomplete ([314df47](https://github.com/GetTerminus/terminus-ui/commit/314df47))
+* fix(Select): split `TsAutocomplete` and `TsSelect` into seperate components ([314df47](https://github.com/GetTerminus/terminus-ui/commit/314df47))
+
+
+### BREAKING CHANGES & Migration Notes
+
+#### Select
+
+- Dropped support for `formatUIFn`. Select only supports `string` values now. It is up to the consumer to map the string value to a complex value if needed.
+- No longer supporting autocomplete features. They have been moved to `TsAutocomplete`.
+- `TsSelectChange` value property is no longer generic; it is now `string | string[]`.
+
+#### Option
+
+- Has been renamed from `ts-select-option` to `ts-option` as it is used by multiple components. All functionality remains the same.
+
+```html
+<!-- Current -->
+<ts-select-option>
+  ...
+</ts-select-option>
+
+<!-- New -->
+<ts-option>
+  ...
+</ts-option>
+```
 
+- The import endpoint has also changed to `@terminus/ui/option`.
+
+```typescript
+// Current
+@import { TsSelectOption } from '@terminus/ui/select';
+
+// New
+@import { TsOption } from '@terminus/ui/option';
+```
+
+#### Autocomplete
+
+- This component has been un-deprecated and updated.
+- `TsAutocomplete` still has the same basic functions it had when combined with `TsSelect`.
+- `TsAutocomplete` leverages the same `<ts-option>` as `TsSelect`:
+
+```html
+<!-- Example -->
+<ts-autocomplete
+  label="Autocomplete Example"
+  hint="Begin typing to select.."
+  [formControl]="stateCtrl"
+  (queryChange)="queryHasChanged($event)"
+>
+  <ts-option
+    [value]="state.name"
+    [option]="state"
+    *ngFor="let state of filteredStates | async"
+  >
+    {{ state.name }}
+  </ts-option>
+</ts-autocomplete>
+```
 
-### BREAKING CHANGE
+- Autocomplete only supports `string` as it's value type. The selection value will always be `string[]`.
+- Dropped support for `chipFormatFn`. For any type other than `string`, it is up to consumer to manage mapping that value to a complex value.
 
-* Select no longer supports autocomplete functionality. The deprecated autocomplete component now has
-been updated and un-deprecated.
 
 ## <small>12.1.7 (2019-06-05)</small>