Skip to content
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

[BadgeUnstyled] Add useBadge hook #30246

Merged
merged 7 commits into from
Dec 22, 2021
Merged

[BadgeUnstyled] Add useBadge hook #30246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
508e420
[BadgeUnstyled] Add useBadge hook
mnajdova Dec 17, 2021
f6aaeb7
Fix CI
mnajdova Dec 17, 2021
e940e89
Fix wrong export
mnajdova Dec 17, 2021
353d53d
Merge branch 'master' into feat/add-useBadge-hook
mnajdova Dec 21, 2021
7674166
Move the overlap prop from BadgeUnstyled to Badge
mnajdova Dec 21, 2021
ef7c433
Fix visual regressions
mnajdova Dec 21, 2021
cc441f3
docs:typescript:formatted
mnajdova Dec 21, 2021
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
28 changes: 8 additions & 20 deletions docs/pages/api-docs/badge-unstyled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
"componentsProps": { "type": { "name": "object" }, "default": "{}" },
"invisible": { "type": { "name": "bool" } },
"max": { "type": { "name": "number" }, "default": "99" },
"overlap": {
"type": { "name": "enum", "description": "'circular'<br>&#124;&nbsp;'rectangular'" },
"default": "'rectangular'"
},
"showZero": { "type": { "name": "bool" } },
"variant": { "type": { "name": "string" }, "default": "'standard'" }
},
Expand All @@ -32,29 +28,21 @@
"badge",
"dot",
"standard",
"anchorOriginTopRightRectangular",
"anchorOriginBottomRightRectangular",
"anchorOriginTopLeftRectangular",
"anchorOriginBottomLeftRectangular",
"anchorOriginTopRightCircular",
"anchorOriginBottomRightCircular",
"anchorOriginTopLeftCircular",
"anchorOriginBottomLeftCircular",
"anchorOriginTopRight",
"anchorOriginBottomRight",
"anchorOriginTopLeft",
"anchorOriginBottomLeft",
"invisible"
],
"globalClasses": {
"root": "MuiBadge-root",
"badge": "MuiBadge-badge",
"dot": "MuiBadge-dot",
"standard": "MuiBadge-standard",
"anchorOriginTopRightRectangular": "MuiBadge-anchorOriginTopRightRectangular",
"anchorOriginBottomRightRectangular": "MuiBadge-anchorOriginBottomRightRectangular",
"anchorOriginTopLeftRectangular": "MuiBadge-anchorOriginTopLeftRectangular",
"anchorOriginBottomLeftRectangular": "MuiBadge-anchorOriginBottomLeftRectangular",
"anchorOriginTopRightCircular": "MuiBadge-anchorOriginTopRightCircular",
"anchorOriginBottomRightCircular": "MuiBadge-anchorOriginBottomRightCircular",
"anchorOriginTopLeftCircular": "MuiBadge-anchorOriginTopLeftCircular",
"anchorOriginBottomLeftCircular": "MuiBadge-anchorOriginBottomLeftCircular",
"anchorOriginTopRight": "MuiBadge-anchorOriginTopRight",
"anchorOriginBottomRight": "MuiBadge-anchorOriginBottomRight",
"anchorOriginTopLeft": "MuiBadge-anchorOriginTopLeft",
"anchorOriginBottomLeft": "MuiBadge-anchorOriginBottomLeft",
"invisible": "MuiBadge-invisible"
},
"name": null
Expand Down
20 changes: 13 additions & 7 deletions docs/pages/api-docs/badge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,17 @@
"badge",
"dot",
"standard",
"anchorOriginTopRight",
"anchorOriginBottomRight",
"anchorOriginTopLeft",
"anchorOriginBottomLeft",
"invisible",
"colorPrimary",
"colorSecondary",
"colorError",
"colorInfo",
"colorSuccess",
"colorWarning",
"anchorOriginTopRightRectangular",
"anchorOriginBottomRightRectangular",
"anchorOriginTopLeftRectangular",
Expand All @@ -59,13 +70,8 @@
"anchorOriginBottomRightCircular",
"anchorOriginTopLeftCircular",
"anchorOriginBottomLeftCircular",
"invisible",
"colorPrimary",
"colorSecondary",
"colorError",
"colorInfo",
"colorSuccess",
"colorWarning"
"overlapRectangular",
"overlapCircular"
],
"globalClasses": {},
"name": "MuiBadge"
Expand Down
6 changes: 3 additions & 3 deletions docs/src/pages/components/badges/UnstyledBadge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ const StyledBadge = styled(BadgeUnstyled)`
box-shadow: 0 0 0 1px #fff;
}

& .MuiBadge-anchorOriginTopRightCircular {
& .MuiBadge-anchorOriginTopRight {
position: absolute;
top: 0;
right: 0;
Expand Down Expand Up @@ -73,10 +73,10 @@ function BadgeContent() {
export default function UnstyledBadge() {
return (
<Box sx={{ '& > :not(style) + :not(style)': { ml: 4 } }}>
<StyledBadge badgeContent={5} overlap="circular">
<StyledBadge badgeContent={5}>
<BadgeContent />
</StyledBadge>
<StyledBadge badgeContent={5} variant="dot" overlap="circular">
<StyledBadge badgeContent={5} variant="dot">
<BadgeContent />
</StyledBadge>
</Box>
Expand Down
6 changes: 3 additions & 3 deletions docs/src/pages/components/badges/UnstyledBadge.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ const StyledBadge = styled(BadgeUnstyled)`
box-shadow: 0 0 0 1px #fff;
}

& .MuiBadge-anchorOriginTopRightCircular {
& .MuiBadge-anchorOriginTopRight {
position: absolute;
top: 0;
right: 0;
Expand Down Expand Up @@ -73,10 +73,10 @@ function BadgeContent() {
export default function UnstyledBadge() {
return (
<Box sx={{ '& > :not(style) + :not(style)': { ml: 4 } }}>
<StyledBadge badgeContent={5} overlap="circular">
<StyledBadge badgeContent={5}>
<BadgeContent />
</StyledBadge>
<StyledBadge badgeContent={5} variant="dot" overlap="circular">
<StyledBadge badgeContent={5} variant="dot">
<BadgeContent />
</StyledBadge>
</Box>
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/components/badges/UnstyledBadge.tsx.preview
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<StyledBadge badgeContent={5} overlap="circular">
<StyledBadge badgeContent={5}>
<BadgeContent />
</StyledBadge>
<StyledBadge badgeContent={5} variant="dot" overlap="circular">
<StyledBadge badgeContent={5} variant="dot">
<BadgeContent />
</StyledBadge>
37 changes: 8 additions & 29 deletions docs/translations/api-docs/badge-unstyled/badge-unstyled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"componentsProps": "The props used for each slot inside the Badge.",
"invisible": "If <code>true</code>, the badge is invisible.",
"max": "Max count to show.",
"overlap": "Wrapped shape the badge should overlap.",
"showZero": "Controls whether the badge is hidden when <code>badgeContent</code> is zero.",
"variant": "The variant to use."
},
Expand All @@ -30,45 +29,25 @@
"nodeName": "the badge `span` element",
"conditions": "<code>variant=\"standard\"</code>"
},
"anchorOriginTopRightRectangular": {
"anchorOriginTopRight": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'right' }} overlap=\"rectangular\"</code>"
"conditions": "<code>anchorOrigin={{ 'top', 'right' }}</code>"
},
"anchorOriginBottomRightRectangular": {
"anchorOriginBottomRight": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }} overlap=\"rectangular\"</code>"
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }}</code>"
},
"anchorOriginTopLeftRectangular": {
"anchorOriginTopLeft": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'left' }} overlap=\"rectangular\"</code>"
"conditions": "<code>anchorOrigin={{ 'top', 'left' }}</code>"
},
"anchorOriginBottomLeftRectangular": {
"anchorOriginBottomLeft": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }} overlap=\"rectangular\"</code>"
},
"anchorOriginTopRightCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'right' }} overlap=\"circular\"</code>"
},
"anchorOriginBottomRightCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }} overlap=\"circular\"</code>"
},
"anchorOriginTopLeftCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'left' }} overlap=\"circular\"</code>"
},
"anchorOriginBottomLeftCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }} overlap=\"circular\"</code>"
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }}</code>"
},
"invisible": {
"description": "State class applied to {{nodeName}} if {{conditions}}.",
Expand Down
86 changes: 58 additions & 28 deletions docs/translations/api-docs/badge/badge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,45 +32,25 @@
"nodeName": "the badge `span` element",
"conditions": "<code>variant=\"standard\"</code>"
},
"anchorOriginTopRightRectangular": {
"anchorOriginTopRight": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'right' }} overlap=\"rectangular\"</code>"
"conditions": "<code>anchorOrigin={{ 'top', 'right' }}</code>"
},
"anchorOriginBottomRightRectangular": {
"anchorOriginBottomRight": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }} overlap=\"rectangular\"</code>"
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }}</code>"
},
"anchorOriginTopLeftRectangular": {
"anchorOriginTopLeft": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'left' }} overlap=\"rectangular\"</code>"
"conditions": "<code>anchorOrigin={{ 'top', 'left' }}</code>"
},
"anchorOriginBottomLeftRectangular": {
"anchorOriginBottomLeft": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }} overlap=\"rectangular\"</code>"
},
"anchorOriginTopRightCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'right' }} overlap=\"circular\"</code>"
},
"anchorOriginBottomRightCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }} overlap=\"circular\"</code>"
},
"anchorOriginTopLeftCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'left' }} overlap=\"circular\"</code>"
},
"anchorOriginBottomLeftCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }} overlap=\"circular\"</code>"
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }}</code>"
},
"invisible": {
"description": "State class applied to {{nodeName}} if {{conditions}}.",
Expand Down Expand Up @@ -106,6 +86,56 @@
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>color=\"warning\"</code>"
},
"anchorOriginTopRightRectangular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'right' }} overlap=\"rectangular\"</code>"
},
"anchorOriginBottomRightRectangular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }} overlap=\"rectangular\"</code>"
},
"anchorOriginTopLeftRectangular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'left' }} overlap=\"rectangular\"</code>"
},
"anchorOriginBottomLeftRectangular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }} overlap=\"rectangular\"</code>"
},
"anchorOriginTopRightCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'right' }} overlap=\"circular\"</code>"
},
"anchorOriginBottomRightCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'right' }} overlap=\"circular\"</code>"
},
"anchorOriginTopLeftCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'top', 'left' }} overlap=\"circular\"</code>"
},
"anchorOriginBottomLeftCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>anchorOrigin={{ 'bottom', 'left' }} overlap=\"circular\"</code>"
},
"overlapRectangular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>overlap=\"rectangular\"</code>"
},
"overlapCircular": {
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the badge `span` element",
"conditions": "<code>overlap=\"circular\"</code>"
}
}
}
Loading