{"bugs":{"url":"https://github.com/material-components/material-components-web/issues"},"dist":{"shasum":"f8bd8664be568d4166824fdc50bb9fd4dcc143b5","tarball":"https://registry.npmjs.org/@material/shape/-/shape-3.0.0-alpha.1.tgz","fileCount":6,"integrity":"sha512-i34JzahA5pF/pR+Vh7b4UntQ2PcAFlKhk3g81ozyHavKL6jA8Pm1ZvgG4rMUsHBJYpM/zQDvTrsJhc3IFTAFnQ==","signatures":[{"sig":"MEUCICOs89QVRvN3SRZ9t0aE+UQ9O9wH9pxTQwlZ+jl/mv3MAiEA717ssP7BoFoCbFQSn/zkDOgHP7cH3I+UXZY16qRDIEk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":15705,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdAUwlCRA9TVsSAnZWagAABLcQAJHyoXMRQHNduraQ424q\nN7dP6vkJ924i4UdkB6wR9aHoXsbIott9UDY/iPYu51JUbqqRY79wn8PFsiMT\ndo9DIofK9xSLFgxYxqwHQ4PFqXtyp/GtIYb28hbrGLpF11og9eCGm0S2yHBJ\nQnW1xNoRbo1G1ave9gUc3r/h99GuflTKNU15t6UB84rvJ/QoT4/6MefuLV47\nNa3pi8atZl1OzmLSNXFVnN6VcP4VmKRUoPHVhT8ITxbe0jt0iZ0O9x+qeplC\nt96Ejv7NEeO7Do6dJpX2ZgggEF6iH2i53wLQ6Pa8WrdvTx3XLW1TmMqZjnFn\nqxzuD3RmJw4bYuW5r8njn2Wejg2zYIeUkgd1o/02M54gtU8raGGyoR9zSnQF\nHUi4yc0Go8BhQZ3X00B75cm6ehcc8RlotJU1Zmsd/kXHb+Ze0m519e3PYdgh\nXIFAFlV3ulOiZ0Qlu5riIIZ8+HVzrjGU4FfS3YsHKRh6PKXRj8l9kIvmlOg0\nw5PMQbX7gNW4YcdWoVYiBZBRV8kv6jrV+y9CL23ROO8amNWgxHQaZW56a74X\nqlKhi3aAVf5hW5fLDbFMK2Cx01XwVLUt0u94GnsjeKPv1TGXBMQFIf/9WiAk\nfrkx5OUZ+XogVxmhlZ5+HeCoeQBbB5bxoqFxeMcIM0uJlBU1OONghF/uA8yN\nT37D\r\n=MISy\r\n-----END PGP SIGNATURE-----\r\n"},"name":"@material/shape","readme":"\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\n\n## Installation\n\n```\nnpm install @material/shape\n```\n\n## Basic Usage\n\n### Styles\n\n```scss\n@import \"@material/shape/mixins\";\n@import \"@material/shape/functions\";\n```\n\n## Style Customization\n\n### Sass Variables\n\nComponents are categorized as small, medium and large in shape system. Overriding below sass variables applies shape (rounded) to respective categories. For example, overriding `$mdc-shape-medium-radius` variable would apply shape to all components that belong to medium category.\n\nVariable | Description\n--- | ---\n`$mdc-shape-small-component-radius` | Rounded shape radius size for small components. Default value `4px`.\n`$mdc-shape-medium-component-radius` | Rounded shape radius size for medium components. Default value `4px`.\n`$mdc-shape-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### Sass Mixins\n\nMixin | Description\n--- | ---\n`mdc-shape-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> Use `mdc-shape-resolve-percentage-radius` sass function to resolve percentage unit value to absolute radius value.\n\n### Sass Functions\n\nFunction | Description\n--- | ---\n`mdc-shape-flip-radius($radius)` | Flips the radius values in RTL context. `$radius` is list of 2-4 corner values.\n`mdc-shape-resolve-percentage-radius($component-height, $radius)` | Calculates the absolute radius value based on its component height. Use this for fixed height components only.\n`mdc-shape-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`mdc-shape-prop-value($radius)` | Returns `$radius` value of shape category - `large`, `medium` or `small`. Otherwise, it returns the `$radius` itself if valid. `$radius` can be a single value or list of up to 4.\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@include mdc-shape-radius(mdc-shape-resolve-percentage-radius($mdc-button-height, $radius));\n```\n\nWhere, `$mdc-button-height` is the height of standard button and `$radius` is the size of shape. `mdc-shape-resolve-percentage-radius` function is used to resolve percentage unit value to absolute `$radius` value based on component 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 mdc-shape-radius($radius);\n```\n\nWhere, `$radius` is 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 mdc-shape-radius(0 $radius $radius 0, $rtl-reflexive: true);\n```\n\nWhere, only top-right & bottom-right corners are customizable and it automatically flips radius values based on RTL context when `$rtl-reflexive` is set to true.\n\n#### Component theming\n\nThe styles for applying custom shape to button component instance looks like this:\n\n```scss\n@import \"@material/button/mixins\";\n\n.my-custom-button {\n @include mdc-button-shape-radius(50%);\n}\n```\n\nIn this example, the above styles applies 50% (pill) shape to button. It can also be absolute value (e.g., `8px`);\n\n> You would indirectly use the Shape API through respective component's mixin which takes care of applying radius to applicable corners for all its variants.\n","gitHead":"dae97b98c21bb93075a9688cf1f9076a4fe5a85d","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"},"_npmVersion":"lerna/3.14.1/node@v11.9.0+x64 (darwin)","description":"Shape utilities for Material Components for the web","directories":{},"maintainers":[{"name":"abhiomkar","email":"abhiomkar@gmail.com"},{"name":"acdvorak","email":"acdvorak@gmail.com"},{"name":"aprigogin","email":"andrey.prigogin@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":"kfranqueiro","email":"kenneth.franqueiro@gmail.com"},{"name":"lynnjepsen","email":"lynnjepsen@google.com"},{"name":"material-admin","email":"lynnjepsen+npm@google.com"},{"name":"moog16","email":"mattgoo@gmail.com"},{"name":"patrickrodee","email":"prodee@google.com"},{"name":"williamernest","email":"williamernest@google.com"}],"_nodeVersion":"11.9.0","dependencies":{"@material/feature-targeting":"^0.44.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/shape_3.0.0-alpha.1_1560366117167_0.4004867059001944","host":"s3://npm-registry-packages"},"_id":"@material/shape@3.0.0-alpha.1","version":"3.0.0-alpha.1"}