Skip to content

Commit f59e5c5

Browse files
authored
Remove support for FormattedTextField (#2993)
### Background Part of https://github.com/shop/issues-retail/issues/1955 TL;DR: FormattedTextField has been deprecated for the last major release, dropping support. ### Solution This PR removes the deprecated `FormattedTextField` component from the Point of Sale UI Extensions. The component was previously marked as deprecated in favor of the `TextField` component. This change: - Removes the `FormattedTextField` component implementation - Removes related documentation and screenshots - Removes the exported `AutoCapitalizationType` type - Updates the versions documentation to note this breaking change This completes the deprecation cycle by fully removing the component, ensuring developers use the recommended `TextField` component instead. Updated component page: <img width="1046" alt="image" src="https://github.com/user-attachments/assets/18644959-2f54-423b-b37f-dc68c68cf5e2" /> Updated versions page: <img width="806" alt="image" src="https://github.com/user-attachments/assets/0c85a7e8-604c-440c-81ef-2d7dfdde31eb" /> ### 🎩 - Verified that the `TextField` component provides all the functionality needed to replace `FormattedTextField` - Confirmed documentation properly directs users to the `TextField` component ### Checklist - [x] I have 🎩'd these changes - [x] I have updated relevant documentation
1 parent 3d2607e commit f59e5c5

File tree

13 files changed

+10
-180
lines changed

13 files changed

+10
-180
lines changed

.changeset/clean-pears-train.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@shopify/ui-extensions-react': major
3+
'@shopify/ui-extensions': major
4+
---
5+
6+
Drop support for deprecated FormattedTextField

packages/ui-extensions-react/src/surfaces/point-of-sale.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,10 @@ export type {
1414
ButtonProps,
1515
CameraScannerProps,
1616
DateFieldProps,
17-
InputType,
1817
DatePickerProps,
1918
DialogType,
2019
DialogProps,
2120
EmailFieldProps,
22-
FormattedTextFieldProps,
2321
IconName,
2422
IconSize,
2523
IconProps,
@@ -51,7 +49,6 @@ export type {
5149
Segment,
5250
SegmentedControlProps,
5351
SelectableProps,
54-
AutoCapitalizationType,
5552
BaseTextFieldProps,
5653
InputAction,
5754
InputProps,

packages/ui-extensions-react/src/surfaces/point-of-sale/components.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ export {DateField} from './components/DateField/DateField';
77
export {DatePicker} from './components/DatePicker/DatePicker';
88
export {Dialog} from './components/Dialog/Dialog';
99
export {EmailField} from './components/EmailField/EmailField';
10-
export {FormattedTextField} from './components/FormattedTextField/FormattedTextField';
1110
export {Icon} from './components/Icon/Icon';
1211
export {Image} from './components/Image/Image';
1312
export {List} from './components/List/List';

packages/ui-extensions-react/src/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.ts

Lines changed: 0 additions & 9 deletions
This file was deleted.

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/FormattedTextField.doc.ts

Lines changed: 0 additions & 42 deletions
This file was deleted.

packages/ui-extensions/docs/surfaces/point-of-sale/reference/examples/formatted-text-field/default.example.ts

Lines changed: 0 additions & 46 deletions
This file was deleted.

packages/ui-extensions/docs/surfaces/point-of-sale/reference/examples/formatted-text-field/default.example.tsx

Lines changed: 0 additions & 37 deletions
This file was deleted.

packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ Refer to the [migration guide](/docs/api/pos-ui-extensions/migrating) for more i
5858
- Update pos.draft-order-details.block.render allowed components to \`BlockComponents\`.
5959
- Added support for a product variant id field in the \`ProductApi\` interface.
6060
61+
### Breaking Changes
62+
63+
- Removed the deprecated \`FormattedTextField\` component. Use the \`TextField\` component instead.
64+
6165
### Features
6266
6367
- Added required \`posVersion\` property to \`Session\` interface.

0 commit comments

Comments
 (0)