{"bugs":{"url":"https://github.com/material-components/material-components-web/issues"},"dist":{"shasum":"dc68855a2754d01d0c286bb9a30fb5da57eede6d","tarball":"https://registry.npmjs.org/@material/shape/-/shape-7.0.0-canary.d86ad3b60.0.tgz","fileCount":13,"integrity":"sha512-OIWuwYLDRzRjstrFkyXKpRbEMHHN5w4ErUVzXecYYkqobEVmOvuGETAZMNiSOOzr0fhL+B3J9bSEw6/wZDzBZw==","signatures":[{"sig":"MEUCIHVY6544rc61/ZgpylAbL7K8GOWPoXdbZkADdJ/kzxlkAiEA++jRtGJmJvuXRoePW/b/CVO8+wkJ83QLOSbO8KUBEKk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24096,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe1T94CRA9TVsSAnZWagAA1ssP/jdV47TE1Ep8XdbJ6Z4h\nj6IPHzOkaP4Q8fxnHzk/yZHqGZlhEglZsmplMaVM85zZfHZPZQ3um0wqWNjc\nI3JcI1lzuHH8MAyXfxPdPY+YiB4HQWkwg+aITNwL0pLBoWP8gZyFUNGNm5ZC\nWlqAcO9yQ2hLajcbm2baC8e6OWzdq4Ya9MnNSt/wkIoUCFHeN5XD9SFPu+P/\nSShQJVDe1JINkPVq31ZXblNseG6xcL8F5Zo5V/sH+visdDlo/ulFhmqN4Szr\nEiJZTJMjqOUt43POpfA9CK5uVYyZYmLSLrVNpaPJSzG95EVX+v4AlnsMjuZz\n/Nc84siK4A68p/cy3itzumQV1Ec7ukO0KIbymlAH+KvZlZYUXlEKKrj8qNAN\n3+pWv9d1eEsFTblx1O1UOiRQ6ySRzpA1xLjcwYfIv3qIkpEeLlqrltEo2aSI\nbaeI4zCBhpVHaQoT0KcpBBo6ikXeAX3naHwSu+YRtrTr7T+ihfgeoItj98B9\nIbtrnNCQfIkV/fT4uRrUKs6ufPE5Vnv3EzTJ3EKlbvP8KKjvWQcH/QG95gTN\nxMhMIHv/4Y9P0VU52oJu5hAJFxM2KkXHK2j6N/XWYjSZ1DIfJMzuB4QR8vyz\nljou0VNXFrs8NQ5DyIEjhdWze7mEJKIglc1nyKZS12xYp6qGllhqyBDeNTKH\nL4XH\r\n=CQp/\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":"ff64ee77c98ab8a932f9397689714c078eb9fd02","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@v10.20.1+x64 (linux)","description":"Shape utilities for Material Components for the web","directories":{},"maintainers":[{"name":"abhiomkar","email":"abhiomkar@gmail.com"},{"name":"acdvorak","email":"acdvorak@gmail.com"},{"name":"allanchen","email":"allanchen@google.com"},{"name":"aomarks","email":"aomarks@google.com"},{"name":"aprigogin","email":"andrey.prigogin@gmail.com"},{"name":"asyncliz","email":"asyncliz@gmail.com"},{"name":"azakus","email":"dfreedm2@gmail.com"},{"name":"bicknellr","email":"bicknellr@gmail.com"},{"name":"bonniez","email":"bonniez@google.com"},{"name":"bwobrien","email":"obrien.test@gmail.com"},{"name":"candysonya","email":"wangchan518@gmail.com"},{"name":"emarquez","email":"emarquez@google.com"},{"name":"esgonzalez","email":"esgonzalez@google.com"},{"name":"kfranqueiro","email":"kenneth.franqueiro@gmail.com"},{"name":"lynnjepsen","email":"lynnjepsen@google.com"},{"name":"material-admin","email":"aprigogin+npm@google.com"},{"name":"moog16","email":"mattgoo@gmail.com"},{"name":"patrickrodee","email":"prodee@google.com"},{"name":"williamernest","email":"williamernest@google.com"}],"_nodeVersion":"10.20.1","dependencies":{"@material/rtl":"7.0.0-canary.d86ad3b60.0","@material/theme":"7.0.0-canary.d86ad3b60.0","@material/feature-targeting":"7.0.0-canary.d86ad3b60.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/shape_7.0.0-canary.d86ad3b60.0_1591033719702_0.32060517246983755","host":"s3://npm-registry-packages"},"_id":"@material/shape@7.0.0-canary.d86ad3b60.0","version":"7.0.0-canary.d86ad3b60.0"}