gniben v0.3.3

Gniben

A batteries included js optional popover

Installation

npm i gniben

Usage

<script>
	import Gniben from 'gniben';
</script>

<Gniben>
	<button slot="target">Use to me toggle the popover</button>
	<div slot="content">
		Whatever you put here will be hidden/shown by pressing the button even without js enabled
	</div>
</Gniben>

Attributes

Gniben will check certain attributes on the content within the slots in order to provide better functionality

data-gniben-close

Click events on elements with the data attribute gniben-close will automatically close the popover

<Gniben>
	<button slot="target">Toggle</button>
	<div slot="content">
		<button data-gniben-close>Clicking me will close the popover</button>
	</div>
</Gniben>

autofocus

When opening the popover Gniben will automatically focus the first element in the content slot that has the attribute autofocus (if any).

<Gniben>
	<button slot="target">Toggle</button>
	<div slot="content">
		<input autofocus />
	</div>
</Gniben>

Slots

Open

The open slot can be used for example to change content or styling based on whether or not the popover is open

<Gniben let:open>
	<button slot="target">{#if open} i am now open {:else} i am closed {/if}</button>
	<div slot="content">...</div>
</Gniben>

Elements

under the hood Gniben renders a details and summary element it exposes all relevant elements as slots so that you can reference them for focus management and what else you may need

<!-- This -->
<Gniben let:element let:target let:content>
	<button slot="target">...</button>
	<div slot="content">...</div>
</Gniben>

<!-- Becomes -->
<details bind:this="{element}">
	<summary bind:this="{target}">
		<button>...</button>
	</summary>
	<div bind:this="{content}">...</div>
</details>