@material/shape
Advanced tools
Changelog
14.0.0 (2022-04-27)
unset is unsupported in IE. (f460e23)validateTooltipWithCaretDistances method. (3e30054)theme-styles mixin... the value being retreived from the $theme map and css property name was swapped. The mixin would request font-size/font-weight/letter-spacing from the $theme map (which expects size/weight/tracking)... so these values would always be null. (32b3913)attachTo. (05db65e)showTimeout is not set (indicating that this tooltip is about to be re-shown). (6ca8b8f)minRange param to range sliders to request a minimum gap between the two thumbs. (8fffcb5)valueToAriaValueTextFn and valueToValueIndicatorTextFn functions are called for. (b6510c8)PiperOrigin-RevId: 444830518
PiperOrigin-RevId: 419837612
Readme
Shapes direct attention, identify components, communicate state, and express brand.
Currently shape system for web only supports rounded corners.
npm install @material/shape
@use "@material/shape";
Components are categorized as small, medium, and large in the Material shape system. Overriding the below Sass variables will change all components in their respective categories.
| Variable | Description |
|---|---|
$small-component-radius | Rounded shape radius size for small components. Default value 4px. |
$medium-component-radius | Rounded shape radius size for medium components. Default value 4px. |
$large-component-radius | Rounded shape radius size for large components. Default value 0. |
Please refer Material Design guidelines: Shape to learn about how components are categorized.
Note: Only rounded shape designs are currently supported.
| CSS Custom Property | Description |
|---|---|
--mdc-shape-small | Rounded shape radius size for small components. Default value 4px. |
--mdc-shape-medium | Rounded shape radius size for small components. Default value 4px. |
--mdc-shape-large | Rounded shape radius size for small components. Default value 0. |
Note: Do not use percentage values with custom properties, since they cannot be resolved by shape.radius() at runtime.
| Mixin | Description |
|---|---|
radius($radius, $rtl-reflexive) | Shape API used by all other components to apply radius to appropriate corners. $radius can be single value or list of up to 4 radius corner values. Set $rtl-reflexive to true to flip the radius in RTL case, false by default. |
| Function | Description |
|---|---|
resolve-radius($radius, $component-height) | Returns the resolved radius value of a shape category - large, medium, or small. If $radius is not a category, this function returns the value itself if valid. Valid values are numbers or percentages. $component-height should be provided if $radius may be a percentage. |
flip-radius($radius) | Flips the radius values in RTL context. $radius is list of 2-4 corner values. |
mask-radius($radius, $masked-corners) | Accepts radius number or list of 2-4 radius values and returns 4 value list with masked corners as mentioned in $masked-corners. |
unpack-radius($radius) | Unpacks shorthand values for border-radius (i.e. lists of 1-3 values). If a list of 4 values is given, it is returned as-is. |
Styles for applying shape to a fixed height component such as button looks like this:
@use "@material/button";
@include shape.radius($radius, $component-height: button.$height);
Where button.$height is the height of standard button and $radius is the size of the shape. shape.radius() will resolve any percentage unit value to an absolute radius value based on the component's height.
Styles for applying shapes to dynamic height component such as card looks like this:
@include shape.radius($radius);
Where $radius is an absolute value only.
Styles for applying shapes for specific corners such as drawer looks like this:
@include shape.radius(0 $radius $radius 0, $rtl-reflexive: true);
Where only top-right & bottom-right corners are customizable. shape.radius() will automatically flip radius values based on RTL context if $rtl-reflexive is set to true.
The styles for applying custom shape to a button component looks like this:
@use "@material/button";
.my-custom-button {
@include button.shape-radius(50%);
}
In this example, the above style applies a 50% pill shape to the button. It could also be an absolute value (e.g., 8px);
The Shape API is typically used indirectly through each respective component's mixin, which takes care of setting height and applying radius to applicable corners for all of its variants.
FAQs
Shape utilities for Material Components for the web
The npm package @material/shape receives a total of 1,024,851 weekly downloads. As such, @material/shape popularity was classified as popular.
We found that @material/shape demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.