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.
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
Un-nest get-props
workspace
#11863
Comments
Investigation: Originally,
There's a new Next.js option However, when I attempted to delete the
... make changes
diff --git a/../props-main-sorted.json b/../props-pnpm.json
index b76f43abf..8223f4c3f 100644
--- a/../props-main-sorted.json
+++ b/../props-pnpm.json
@@ -1004,7 +1004,7 @@
"filePath": "polaris-react/src/components/AppProvider/AppProvider.tsx",
"syntaxKind": "PropertySignature",
"name": "theme",
- "value": "\"light\" | \"light-mobile\" | \"light-high-contrast-experimental\" | \"dark-experimental\"",
+ "value": "ThemeName",
"description": "",
"isOptional": true
},
@@ -1497,7 +1497,7 @@
"filePath": "polaris-react/src/components/Banner/utilities.ts",
"syntaxKind": "PropertySignature",
"name": "icon",
- "value": "ColorTextAlias | ColorIconAlias",
+ "value": "any",
"description": ""
}
],
@@ -2168,7 +2168,7 @@
"filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
"syntaxKind": "PropertySignature",
"name": "marginInline",
- "value": "Spacing",
+ "value": "any",
"description": "Negative horizontal space around children",
"isOptional": true
},
@@ -2176,7 +2176,7 @@
"filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
"syntaxKind": "PropertySignature",
"name": "marginBlock",
- "value": "Spacing",
+ "value": "any",
"description": "Negative vertical space around children",
"isOptional": true
},
@@ -2184,7 +2184,7 @@
"filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
"syntaxKind": "PropertySignature",
"name": "marginBlockStart",
- "value": "Spacing",
+ "value": "any",
"description": "Negative top space around children",
"isOptional": true
},
@@ -2192,7 +2192,7 @@
"filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
"syntaxKind": "PropertySignature",
"name": "marginBlockEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Negative bottom space around children",
"isOptional": true
},
@@ -2200,7 +2200,7 @@
"filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
"syntaxKind": "PropertySignature",
"name": "marginInlineStart",
- "value": "Spacing",
+ "value": "any",
"description": "Negative left space around children",
"isOptional": true
},
@@ -2208,7 +2208,7 @@
"filePath": "polaris-react/src/components/Bleed/Bleed.tsx",
"syntaxKind": "PropertySignature",
"name": "marginInlineEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Negative right space around children",
"isOptional": true
}
@@ -2268,7 +2268,7 @@
"filePath": "polaris-react/src/components/BlockStack/BlockStack.tsx",
"syntaxKind": "PropertySignature",
"name": "gap",
- "value": "Gap",
+ "value": "any",
"description": "The spacing between children",
"isOptional": true
},
@@ -2345,7 +2345,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "borderColor",
- "value": "ColorBorderAlias | \"transparent\"",
+ "value": "any",
"description": "Border color",
"isOptional": true
},
@@ -2497,7 +2497,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "padding",
- "value": "Spacing",
+ "value": "any",
"description": "Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -2505,7 +2505,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "paddingBlock",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical start and end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -2513,7 +2513,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "paddingBlockStart",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -2521,7 +2521,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "paddingBlockEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -2529,7 +2529,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "paddingInline",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal start and end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -2537,7 +2537,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "paddingInlineStart",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -2545,7 +2545,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "paddingInlineEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -2593,7 +2593,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "insetBlockStart",
- "value": "Spacing",
+ "value": "any",
"description": "Top position of box",
"isOptional": true
},
@@ -2601,7 +2601,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "insetBlockEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Bottom position of box",
"isOptional": true
},
@@ -2609,7 +2609,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "insetInlineStart",
- "value": "Spacing",
+ "value": "any",
"description": "Left position of box",
"isOptional": true
},
@@ -2617,7 +2617,7 @@
"filePath": "polaris-react/src/components/Box/Box.tsx",
"syntaxKind": "PropertySignature",
"name": "insetInlineEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Right position of box",
"isOptional": true
},
@@ -3218,7 +3218,7 @@
"filePath": "polaris-react/src/components/Button/Button.tsx",
"syntaxKind": "PropertySignature",
"name": "disclosure",
- "value": "boolean | \"up\" | \"down\" | \"select\"",
+ "value": "boolean | \"down\" | \"up\" | \"select\"",
"description": "Displays the button with a disclosure icon. Defaults to `down` when set to true",
"isOptional": true
},
@@ -3630,7 +3630,7 @@
"filePath": "polaris-react/src/components/Card/Card.tsx",
"syntaxKind": "PropertySignature",
"name": "padding",
- "value": "Spacing",
+ "value": "any",
"description": "The spacing around the card",
"isOptional": true,
"defaultValue": "{xs: '400', sm: '500'}"
@@ -3639,7 +3639,7 @@
"filePath": "polaris-react/src/components/Card/Card.tsx",
"syntaxKind": "PropertySignature",
"name": "roundedAbove",
- "value": "\"xs\" | \"sm\" | \"md\" | \"lg\" | \"xl\"",
+ "value": "BreakpointsAlias",
"description": "Border radius value above a set breakpoint",
"isOptional": true,
"defaultValue": "'sm'"
@@ -4218,7 +4218,7 @@
"filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx",
"syntaxKind": "PropertySignature",
"name": "bleed",
- "value": "Spacing",
+ "value": "any",
"description": "Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4226,7 +4226,7 @@
"filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockStart",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4234,7 +4234,7 @@
"filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4242,7 +4242,7 @@
"filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineStart",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4250,7 +4250,7 @@
"filePath": "polaris-react/src/components/Checkbox/Checkbox.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
}
@@ -4374,7 +4374,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleed",
- "value": "Spacing",
+ "value": "any",
"description": "Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4382,7 +4382,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockStart",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4390,7 +4390,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4398,7 +4398,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineStart",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4406,7 +4406,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
}
@@ -4597,7 +4597,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleed",
- "value": "Spacing",
+ "value": "any",
"description": "Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4605,7 +4605,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockStart",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4613,7 +4613,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4621,7 +4621,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineStart",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -4629,7 +4629,7 @@
"filePath": "polaris-react/src/components/Choice/Choice.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
}
@@ -4905,7 +4905,7 @@
"filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx",
"syntaxKind": "PropertySignature",
"name": "xs",
- "value": "1 | 2 | 5 | 4 | 3 | 6",
+ "value": "1 | 2 | 3 | 4 | 5 | 6",
"description": "Number of columns the section should span on extra small screens",
"isOptional": true
},
@@ -4913,7 +4913,7 @@
"filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx",
"syntaxKind": "PropertySignature",
"name": "sm",
- "value": "1 | 2 | 5 | 4 | 3 | 6",
+ "value": "1 | 2 | 3 | 4 | 5 | 6",
"description": "Number of columns the section should span on small screens",
"isOptional": true
},
@@ -4921,7 +4921,7 @@
"filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx",
"syntaxKind": "PropertySignature",
"name": "md",
- "value": "1 | 2 | 5 | 4 | 3 | 6",
+ "value": "1 | 2 | 3 | 4 | 5 | 6",
"description": "Number of columns the section should span on medium screens",
"isOptional": true
},
@@ -4929,7 +4929,7 @@
"filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx",
"syntaxKind": "PropertySignature",
"name": "lg",
- "value": "1 | 2 | 5 | 4 | 3 | 6 | 7 | 8 | 9 | 10 | 11 | 12",
+ "value": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12",
"description": "Number of columns the section should span on large screens",
"isOptional": true
},
@@ -4937,7 +4937,7 @@
"filePath": "polaris-react/src/components/Grid/components/Cell/Cell.tsx",
"syntaxKind": "PropertySignature",
"name": "xl",
- "value": "1 | 2 | 5 | 4 | 3 | 6 | 7 | 8 | 9 | 10 | 11 | 12",
+ "value": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12",
"description": "Number of columns the section should span on extra large screens",
"isOptional": true
}
@@ -6976,7 +6976,7 @@
"filePath": "polaris-react/src/components/Divider/Divider.tsx",
"syntaxKind": "PropertySignature",
"name": "borderColor",
- "value": "ColorBorderAlias | \"transparent\"",
+ "value": "any",
"description": "Divider border color",
"isOptional": true,
"defaultValue": "'border-secondary'"
@@ -11192,7 +11192,7 @@
"filePath": "polaris-react/src/components/InlineGrid/InlineGrid.tsx",
"syntaxKind": "PropertySignature",
"name": "gap",
- "value": "Gap",
+ "value": "any",
"description": "The spacing between children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -11259,7 +11259,7 @@
"filePath": "polaris-react/src/components/InlineStack/InlineStack.tsx",
"syntaxKind": "PropertySignature",
"name": "gap",
- "value": "Gap",
+ "value": "any",
"description": "The spacing between elements. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -14442,7 +14442,7 @@
"filePath": "polaris-react/src/utilities/link/types.ts",
"syntaxKind": "PropertySignature",
"name": "inputMode",
- "value": "\"text\" | \"url\" | \"none\" | \"search\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\"",
+ "value": "\"url\" | \"none\" | \"search\" | \"text\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\"",
"description": "Hints at the type of data that might be entered by the user while editing the element or its contents",
"isOptional": true
},
@@ -20015,7 +20015,7 @@
"filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx",
"syntaxKind": "PropertySignature",
"name": "theme",
- "value": "\"light\" | \"light-mobile\" | \"light-high-contrast-experimental\" | \"dark-experimental\"",
+ "value": "ThemeName",
"description": "",
"isOptional": true
},
@@ -21818,7 +21818,7 @@
"filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx",
"syntaxKind": "PropertySignature",
"name": "bleed",
- "value": "Spacing",
+ "value": "any",
"description": "Spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -21826,7 +21826,7 @@
"filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockStart",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -21834,7 +21834,7 @@
"filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedBlockEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Vertical end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -21842,7 +21842,7 @@
"filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineStart",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal start spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
},
@@ -21850,7 +21850,7 @@
"filePath": "polaris-react/src/components/RadioButton/RadioButton.tsx",
"syntaxKind": "PropertySignature",
"name": "bleedInlineEnd",
- "value": "Spacing",
+ "value": "any",
"description": "Horizontal end spacing around children. Accepts a spacing token or an object of spacing tokens for different screen sizes.",
"isOptional": true
}
@@ -23336,7 +23336,7 @@
"filePath": "polaris-react/src/components/ActionMenu/components/SecondaryAction/SecondaryAction.tsx",
"syntaxKind": "PropertySignature",
"name": "disclosure",
- "value": "boolean | \"up\" | \"down\" | \"select\"",
+ "value": "boolean | \"down\" | \"up\" | \"select\"",
"description": "Displays the button with a disclosure icon. Defaults to `down` when set to true",
"isOptional": true
},
@@ -25802,7 +25802,7 @@
"filePath": "polaris-react/src/components/Avatar/Avatar.stories.tsx",
"name": "Style",
"syntaxKind": "TypeAliasDeclaration",
- "value": "typeof STYLE_CLASSES[number]"
+ "value": "(typeof STYLE_CLASSES)[number]"
}
},
"SubNavigationItem": {
@@ -27062,7 +27062,7 @@
"filePath": "polaris-react/src/components/ThemeProvider/ThemeProvider.tsx",
"name": "ThemeNameLocal",
"syntaxKind": "TypeAliasDeclaration",
- "value": "typeof themeNamesLocal[number]"
+ "value": "(typeof themeNamesLocal)[number]"
}
},
"ThemeProviderProps": {
@@ -27534,7 +27534,7 @@
"filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx",
"syntaxKind": "PropertySignature",
"name": "padding",
- "value": "Padding",
+ "value": "any",
"description": "",
"isOptional": true
},
@@ -27542,7 +27542,7 @@
"filePath": "polaris-react/src/components/Tooltip/components/TooltipOverlay/TooltipOverlay.tsx",
"syntaxKind": "PropertySignature",
"name": "borderRadius",
- "value": "BorderRadius",
+ "value": "any",
"description": "",
"isOptional": true
},
@@ -27657,7 +27657,7 @@
"filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx",
"syntaxKind": "PropertySignature",
"name": "padding",
- "value": "Padding",
+ "value": "any",
"description": "Padding of content",
"isOptional": true,
"defaultValue": "'default'"
@@ -27666,7 +27666,7 @@
"filePath": "polaris-react/src/components/Tooltip/Tooltip.tsx",
"syntaxKind": "PropertySignature",
"name": "borderRadius",
- "value": "BorderRadius",
+ "value": "any",
"description": "Border radius of the tooltip",
"isOptional": true,
"defaultValue": "'200'"
@@ -29418,7 +29418,7 @@
"filePath": "polaris-react/src/components/UnstyledLink/UnstyledLink.tsx",
"syntaxKind": "PropertySignature",
"name": "inputMode",
- "value": "\"text\" | \"url\" | \"none\" | \"search\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\"",
+ "value": "\"url\" | \"none\" | \"search\" | \"text\" | \"tel\" | \"email\" | \"numeric\" | \"decimal\"",
"description": "Hints at the type of data that might be entered by the user while editing the element or its contents",
"isOptional": true
},
@@ -31250,7 +31250,7 @@
"filePath": "polaris-react/src/utilities/breakpoints.ts",
"syntaxKind": "PropertySignature",
"name": "defaults",
- "value": "boolean | { xsUp?: boolean; xsDown?: boolean; xsOnly?: boolean; smUp?: boolean; smDown?: boolean; smOnly?: boolean; mdUp?: boolean; mdDown?: boolean; mdOnly?: boolean; lgUp?: boolean; lgDown?: boolean; lgOnly?: boolean; xlUp?: boolean; xlDown?: boolean; xlOnly?: boolean; }",
+ "value": "boolean | { [x: `${BreakpointsAlias}${Capitalize<BreakpointsAliasDirection>}`]: boolean; }",
"description": "Default values applied during SSR. Accepts a single value to use for each\nbreakpoint alias, or an object for configuring select breakpoints.",
"defaultValue": "false"
}
@@ -31598,7 +31598,7 @@
"filePath": "polaris-react/src/components/PolarisTestProvider/PolarisTestProvider.tsx",
"syntaxKind": "PropertySignature",
"name": "theme",
- "value": "\"light\" | \"light-mobile\" | \"light-high-contrast-experimental\" | \"dark-experimental\"",
+ "value": "ThemeName",
"description": "",
"isOptional": true
}, It feels to me like the version of TS changes somehow, and as such its heuristics on when to expand / resolve a type have changed, so we get the type name instead of the resolved type in some cases. |
Originally posted by @jesstelford in #11799 (comment)
The text was updated successfully, but these errors were encountered: