Mask
Give an image a consistent silhouette without editing the source.
Preview
Display-only component. It does not own an interaction model.
Example
<.mask src="/photo.jpg" alt="Portrait" shape={:squircle} />
API contract
mask/1
uses declared Phoenix attributes and slots. This table is generated from the compiled component metadata.
| Attribute | Type | Required | Default | Accepted values |
|---|---|---|---|---|
src |
:string |
Yes | — |
Any value matching the declared type |
alt |
:string |
Yes | — |
Any value matching the declared type |
shape |
:atom |
Yes | — |
[:squircle, :heart, :hexagon, :hexagon_2, :decagon, :pentagon, :diamond, :circle, :star, :star_2, :triangle, :triangle_2, :triangle_3, :triangle_4] |
half |
:atom |
No | nil |
[nil, :first, :second] |
class |
:any |
No | nil |
Any value matching the declared type |
rest |
:global |
No | — |
Any value matching the declared type |
States and behavior
Default and caller-supplied variants preserve semantic daisyUI colors and additive classes.
Keyboard and accessibility
Behavioral tests
These automated checks are applied to this component by the package and documentation test suites.
-
ExUnit
Masked image semantics
Preserves image source and alternative text while applying the requested mask shape.
test/vaylan_ui/catalog_test.exs -
Docs
Preview behavior contract
Classified as display. Display-only component. It does not own an interaction model.
examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs -
Docs
Stable public component page
Renders the component name, example, API contract, accepted values, and keyboard and accessibility guidance at its stable URL.
examples/docs/test/vaylan_ui_docs_web/controllers/page_controller_test.exs