Skip to content

Create migration guidance for available-names() function #5122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 11, 2022
Merged

Create migration guidance for available-names() function #5122

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d7e46b
Create documentation for available-names()
lgriffee Feb 9, 2022
414f867
Link to function definition in mega file
lgriffee Feb 10, 2022
eea479a
Update table header language
lgriffee Feb 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions documentation/guides/migrating-from-v8-to-v9.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,16 @@ To help you quickly add these functions and mixins back to your repo, we've crea

A list of functions/mixins and their value equivalents or new token values.

#### `available-names()`

Use `console.log()` to get the function output and hard code the value you need.
Copy link
Contributor Author

@lgriffee lgriffee Feb 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't reference the mega file here and only gave instructions for replacing the instances. But not sure if this is the right approach. Originally in the doc setup I created an "Adding the functions and mixins to your repo" section with the mega file and a "Replacing function and mixin instances with values or tokens" section for how to replace the functions but perhaps that's not the best approach? Wanted to check in about this to make sure I handle this consistently with how we want to in the future (and go back to fix other sections of mine that don't reference the mega file if we decide to go down that route).

Copy link
Contributor

@aveline aveline Feb 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would link the function definition in the mega file. Then consumers have the option to decide on which approach they want to take.


Otherwise, you can copy the function definition and use it locally.

| Deprecated Function | Source |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `available-names()` | [definition](https://github.com/Shopify/polaris-react/blob/b443d114d447df15d9e72914c8ca5058439a175e/documentation/guides/legacy-polaris-v8-public-api.scss#L354-L386) |

#### `border()`

| Function | Replacement Value/Token |
Expand Down