0.0.2 • Published 8 months ago

infield v0.0.2

Weekly downloads
-
License
(MIT OR Apache-2....
Repository
github
Last release
8 months ago

Infield

Provides an HTML custom element <in-field> for in-field labels.

Getting Started

  • Import the JavaScript library in the browser (to define the custom element).
  • Import or <link> the CSS file (for essential light DOM CSS).

Usage

Example:

<in-field labelpos="inside">
    <label slot="label" for="age">Age</label>
    <input id="age" type="number">
</in-field>

Note: attributes are case-sensitive.

JavaScript API

The JavaScript API only defines a function refreshLayout(): void for <in-field> elements. It's mainly useful if your label changed in a way that might break the layout, or more specifically, if it changed its height. This is not automatic because the vast majority of the time labels are static and small, thus deemed not worth it for performance.

Label Position

Label position can be set with the labelpos attribute. It may be:

  • inside: places the label inside the input.
  • border: places the label in the border of the input (doesn't overlap with the input border).
  • outside: places the label outside of the input.
  • onborder: places the label on the border of the input (overlaps with the input border).

While the main point of this library is inside, providing alternatives is useful for when a label shouldn't be in-field because it helps to maintain a consistent style. This is especially true with overflowing input elements such as <textarea> which can create overlapping with in-field labels, hence, the default value for labelpos is not inside (at the time of writing it's border).

Styling

Parts

The following parts are defined:

  • border: use to style the input border (not the input itself!)
  • label: label slot container.
  • body: default slot container.

Properties

<in-field> elements have CSS properties set that are accessible for their rules, the public ones are:

  • --body-pad is the minimal top padding there must be in the body (usually <input>) so it will not overlap with the label.
  • --inside, --border, --outside, --on-border each are set to 1 (without a unit) when the labelpos corresponds with their name (only one can be set at a time), otherwise 0.

Examples

Set margin on the label but only for inside and border label positions:

in-field::part(label) {
	margin-block-start: calc(1rem * max(var(--inside), var(--border)));
}

Uniform distance between labels and inputs (uniform between label positions):

in-field > :nth-child(2) {
	padding: 1rem;
	padding-block-start: calc(var(--body-pad) + 1rem);
}
0.0.2

8 months ago

0.0.1

8 months ago