{"bugs":{"url":"https://github.com/material-components/material-components-web/issues"},"dist":{"shasum":"4d2629bc67fe1eedff2c4ae2de685214f2469ff6","tarball":"https://registry.npmjs.org/@material/shape/-/shape-15.0.0-canary.79a613bbd.0.tgz","fileCount":14,"integrity":"sha512-A+gAbHzaIwSeySx4MD3RJJtBXFE9dmxyfLEQEOSw7nmiAL+H9Cf7lL4NKndhsYxuV/3ql2uAZ6dSLGDS3ncq4A==","signatures":[{"sig":"MEUCIClS0lbcUadWVCaAm3R740ROfGiaNnoNBk+uCRjpvzDeAiEAgZbUg437qYf8JszfzItrmEf2vNroaNQdQAbnDh+kGn4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24802,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjj1DNACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpvhxAAksboXPE7wUcAoOdsLd7gZD+bB7MMwoK+g5I3Ntx+tYbtn78/\r\ndD5dkSFVFR4cJKjdUcIgZv3I4iybmq5Mk5PoJDdPzzLayT/RqORbLxVl3DWn\r\nkcL34lxhwgHSTB59zUUM7bO1nUYR2Oz5gwl/tD9kjP89cdJKrgzqQOUV8P6o\r\n3OkEZPw6MSZ+uPNqYE2/ea8hx2r8lHC3aLf6jRM24lurDPniIZEcJlJyytxa\r\nu6FkfEG9g2YHYulqoAZbLYl4mmP1L/rAC9GA6+t3NJTRcrOYlP2dza5Uth7m\r\n8mWSeYk+/aG6+fXql/7CYsUN45ZzT0HJXMaNzDY/GMDLYcSBhtQWDT4VfbTR\r\nPwfMeAzzQIOyfnyEMngrfbG7zUNVUEosaw171YlmkuoHpg8+ZJ147gFtWqxE\r\njNJMtN0azqroBY2G9z+NKCTijPIbdTNtg0t9o+KQgAzf1sRgFtKJz7tDQqjw\r\nLwPi/a3zGdLncor3ONBwLoFw0u6hxcPqf9VAPuAcXNypZxZMpkxZPL6SV48C\r\nvtKU9dlTboiYEvE2o9iVyfPHS9cMOTf6XKEtXQgy7yKvNFkzL2bqnkf4jNCY\r\nyVxHKun+rZaeEsYeURSy3zSyFb5WDmfwCiafT46Gf5iZ96vLDiU2e8WE/x+S\r\nbKvS4o66AhFkPringS51NsTXixwxjQYqdBo=\r\n=O3BV\r\n-----END PGP SIGNATURE-----\r\n"},"name":"@material/shape","readme":"<!--docs:\ntitle: \"Shape\"\nlayout: detail\nsection: components\nexcerpt: \"Shapes direct attention, identify components, communicate state, and express brand.\"\npath: /catalog/shape/\n-->\n\n# Shape\n\nShapes direct attention, identify components, communicate state, and express brand.\n\n> Currently shape system for web only supports rounded corners.\n\n## Design & API Documentation\n\n<ul class=\"icon-list\">\n  <li class=\"icon-list-item icon-list-item--spec\">\n    <a href=\"https://material.io/go/design-shape\">Material Design guidelines: Shape</a>\n  </li>\n</ul>\n\n## Installation\n\n```\nnpm install @material/shape\n```\n\n## Basic Usage\n\n### Styles\n\n```scss\n@use \"@material/shape\";\n```\n\n## Style Customization\n\n### Sass Variables\n\nComponents 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.\n\nVariable | Description\n--- | ---\n`$small-component-radius` | Rounded shape radius size for small components. Default value `4px`.\n`$medium-component-radius` | Rounded shape radius size for medium components. Default value `4px`.\n`$large-component-radius` | Rounded shape radius size for large components. Default value `0`.\n\nPlease refer [Material Design guidelines: Shape](https://material.io/go/design-shape) to learn about how components are categorized.\n\n**Note: Only rounded shape designs are currently supported.**\n\n### CSS Custom Properties\n\nCSS Custom Property | Description\n--- | ---\n`--mdc-shape-small` | Rounded shape radius size for small components. Default value `4px`.\n`--mdc-shape-medium` | Rounded shape radius size for small components. Default value `4px`.\n`--mdc-shape-large` | Rounded shape radius size for small components. Default value `0`.\n\n**Note: Do not use percentage values with custom properties, since they cannot be resolved by `shape.radius()` at runtime.**\n\n### Sass Mixins\n\nMixin | Description\n--- | ---\n`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.\n\n### Sass Functions\n\nFunction | Description\n--- | ---\n`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.\n`flip-radius($radius)` | Flips the radius values in RTL context. `$radius` is list of 2-4 corner values.\n`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`.\n`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.\n\n### Additional Information\n\n#### Shapes for fixed height components\n\nStyles for applying shape to a fixed height component such as button looks like this:\n\n```scss\n@use \"@material/button\";\n\n@include shape.radius($radius, $component-height: button.$height);\n```\n\nWhere `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.\n\n#### Shapes for dynamic height components\n\nStyles for applying shapes to dynamic height component such as card looks like this:\n\n```scss\n@include shape.radius($radius);\n```\n\nWhere `$radius` is an absolute value only.\n\n#### Shapes for components on specific corners\n\nStyles for applying shapes for specific corners such as drawer looks like this:\n\n```scss\n@include shape.radius(0 $radius $radius 0, $rtl-reflexive: true);\n```\n\nWhere 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.\n\n#### Component theming\n\nThe styles for applying custom shape to a button component looks like this:\n\n```scss\n@use \"@material/button\";\n\n.my-custom-button {\n  @include button.shape-radius(50%);\n}\n```\n\nIn this example, the above style applies a 50% pill shape to the button. It could also be an absolute value (e.g., `8px`);\n\n> 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.\n","gitHead":"755ec1ef0b2cccdcb0c8b888d199b4748e3ba10a","license":"MIT","_npmUser":{"name":"abhiomkar","email":"abhiomkar@gmail.com"},"homepage":"https://github.com/material-components/material-components-web#readme","keywords":["material components","material design","shape"],"repository":{"url":"git+https://github.com/material-components/material-components-web.git","type":"git","directory":"packages/mdc-shape"},"_npmVersion":"lerna/3.20.2/node@v14.21.1+x64 (linux)","description":"Shape utilities for Material Components for the web","directories":{},"maintainers":[{"name":"yefim","email":"hi@yef.im"},{"name":"abhiomkar","email":"abhiomkar@gmail.com"},{"name":"azakus","email":"dfreedm2@gmail.com"},{"name":"bicknellr","email":"bicknellr@gmail.com"},{"name":"material-admin","email":"aprigogin+npm@google.com"},{"name":"aprigogin","email":"andrey.prigogin@gmail.com"},{"name":"patrickrodee","email":"prodee@google.com"},{"name":"aomarks","email":"aomarks@gmail.com"},{"name":"emarquez","email":"emarquez@google.com"},{"name":"allanchen","email":"allanchen@google.com"},{"name":"esgonzalez","email":"esgonzalez@google.com"},{"name":"asyncliz","email":"asyncliz@gmail.com"},{"name":"candysonya","email":"wangchan518@gmail.com"},{"name":"ssuarez","email":"sayrisuarez@google.com"},{"name":"taylorv","email":"brian.t.vann@gmail.com"}],"sideEffects":false,"_nodeVersion":"14.21.1","dependencies":{"tslib":"^2.1.0","@material/rtl":"15.0.0-canary.79a613bbd.0","@material/theme":"15.0.0-canary.79a613bbd.0","@material/feature-targeting":"15.0.0-canary.79a613bbd.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/shape_15.0.0-canary.79a613bbd.0_1670336716937_0.6094721293033569","host":"s3://npm-registry-packages"},"_id":"@material/shape@15.0.0-canary.79a613bbd.0","version":"15.0.0-canary.79a613bbd.0"}