Skip to content

Commit

Permalink
docs(rem): improve usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SukkaW committed Jul 19, 2024
1 parent 4292615 commit 0acdde0
Showing 1 changed file with 28 additions and 19 deletions.
47 changes: 28 additions & 19 deletions docs/src/pages/rem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,32 @@ Convert string or number values in px to `rem` or `em`.
import { rem, em, mantine_rem } from 'foxact/rem';

// numbers and values in px are converted to rem
rem(32); // -> 2rem
em(32); // -> 2em
mantine_rem(32); // -> calc(2rem * var(--mantine-scale))

rem('16px') // -> 1rem
em('16px'); // -> 1em
mantine_rem('16px'); // -> calc(1rem * var(--mantine-scale))

rem('2rem'); // -> 2rem
em('2rem'); // -> 2rem
mantine_rem('2rem'); // -> calc(2rem * var(--mantine-scale))

rem('50%'); // -> 50%
em('50%'); // -> 50%
mantine_rem('50%'); // -> 50%

rem('5vh'); // -> 5vh
em('5vh'); // -> 5vh
mantine_rem('5vh'); // -> 5vh
rem(32); // '2rem'
em(32); // '2em'
mantine_rem(32); // 'calc(2rem * var(--mantine-scale))'

// supports multiple values
rem([32, 16]) // '2rem 1rem'
em('32px 16px') // '2em 1em'

// supports values with "px" unit
rem('16px') // '1rem'
em('16px'); // '1em'
mantine_rem('16px'); // 'calc(1rem * var(--mantine-scale))'

// all non convertable values are returned as is
rem('2rem'); // '2rem'
em('2rem'); // '2rem'
mantine_rem('2rem'); // 'calc(2rem * var(--mantine-scale))'

rem('5vh'); // '5vh'
em('5vh'); // '5vh'
mantine_rem('5vh'); // '5vh'

rem('var(--size)'); // 'var(--size)'
em('var(--size)'); // 'var(--size)'

rem('50%'); // '50%'
em('50%'); // '50%'
mantine_rem('50%'); // '50%'
```

0 comments on commit 0acdde0

Please sign in to comment.