setAttributes also works on any SVG or descendant elements.

Math utils

$3

Clamp a number between two values. A clamped number stays within a specified range. If the number is lower than the minimum, the minimum value is returned. If the number is higher than the maximum, the maximum value is returned.

clamp needs 3 parameters:

1. number: the number to clamp
2. min: the smallest value your number can have
3. max: the highest value your number can have

`js
import { clamp } from 'frontacles/math'

clamp(17, 3, 8) // 8
clamp(-3, 3, 8) // 3
clamp(5, 3, 8) // 5
`

-0 and Infinity are accepted:

`js
clamp(-2, -0, 10) // -0
clamp(5, 0, Infinity) // 5
clamp(Infinity, 0, 10) // 10
`

> [!NOTE]
> clamp mostly follows Math.clamp TC39 proposal, except it doesn’t throw if you flip the order of the _min_ (2nd parameter) and _max_ (3rd parameter) numbers.

$3

Round a number to the (optionally) provided decimal precision. The default precision is 0 (no decimal).

`js
import { round } from 'frontacles/math'

round(687.3456) // 687
round(687.3456, 0) // 687
round(687.3456, 2) // 687.35
`

A negative precision will round up to multiple of tens:

`js
round(687.3456, -1) // 690
round(687.3456, -2) // 700
`

Using Infinity is also possible:

`js
round(Infinity, -2) // Infinity
round(17.853, Infinity // 17.853
`

String utils

$3

Put the first letter of a word in uppercase. It works for Latin, Greek and Cyrillic alphabets.

`js
capitalize('jean-roger')) // 'Jean-roger' (Latin)
capitalize('έρημος')) // 'Έρημος' (Greek)
capitalize('0 books') // 0 books
capitalize('صحراء') // 'صحراء' (Arabic)
`

> [!TIP]
> Before using capitalize, evaluate if CSS could be used instead.
>
> `css
> .my-class::first-letter {
> text-transform: uppercase;
> }
> `

URL utils

$3

Tells whether a string is a valid email.

`js
isEmail('someone@domain.tld') // true
isEmail('invalid@email.com:3000') // false
`

> [!TIP]
> Should I use isEmail or Email.canParse to validate emails?
>
> Short answer: use isEmail.
>
>

$3

A class to instantiate an Email object or validate email addresses. It extends the URL object and has similar predictable behaviors.

#### Email.constructor

`js
import { Email } from 'frontacles/url/email'

const email = new Email('someone@domain.tld')
`

Trying to instantiate an Email with an invalid address will throw. This behaviour is similar to the URL constructor, since Email relies on it under the hood.

`js
new Email('double@at@sign.com') // ❌ throw TypeError
`

Another behaviour from URL: passing an Email object to the Email constructor or to Email.canParse is possible.

`js
const email = new Email('someone@domain.tld')
const alsoEmail = new Email(email) // ✅ a new Email object!
Email.canParse(email) // ✅ true
`

#### .username and .hostname

Get or set the email username and hostname separately.

`js
email.username // 'someone'
email.hostname // 'domain.tld'

email.hostname = 'newdomain.tld' // ✅ domain migrated

// destructuring also works
const { username, hostname } = new Email('someone@domain.tld')
`

#### .toString

In a string context, an Email object is automatically converted to a string, or manually by calling the toString method.

`js
console.log(email: ${email}) // 'email: someone@newdomain.tld'
console.log(email.toString()) // 'someone@newdomain.tld'
`

#### Email.canParse

Validate an email address with Email.canParse.

Unlike most libraries using RegExp to validate a string is an email (which is prone to bugs), Frontacles Email relies on the built-in URL mechanisms, making it robust, and very likely RFC compliant. It passes popular libraries test suites, and beyond.

`js
Email.canParse('someone@domain.tld') // true
Email.canParse('invalid@email.com:3000') // false
`

If canParse is all you need from the Email class, consider using isEmail instead.

Changelog

See CHANGELOG.md or the releases.

Browser and tooling support

frontacles is provided as module for modern browsers usage with standard JavaScript syntax:
- it is up to you to transpile it for legacy browsers;
- you can’t import it using require('frontacles')`.

Read more about ESModules.

Security

See the security policy.

Contributing

See the contributing guidelines.

License

The _datetime-attribute_ package is open-sourced software licensed under the DWTFYWTPL.