@kurone-kito/web-toybox-solid 0.1.0-alpha.1 → 0.1.0-alpha.11

package/docs/interfaces/CreateTickParams.md

@@ -0,0 +1,37 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / CreateTickParams
+
+# Interface: CreateTickParams
+
+Type definition for the parameters of createTick function.
+
+## Properties
+
+### callback()
+
+> `readonly` **callback**: () => `void`
+
+The callback function to be called at each tick.
+
+#### Returns
+
+`void`
+
+***
+
+### immediate?
+
+> `readonly` `optional` **immediate**: `boolean`
+
+Whether to call the callback immediately upon creation.
+
+***
+
+### interval
+
+> `readonly` **interval**: `number`
+
+The interval in milliseconds between each tick.

package/docs/interfaces/HeadProps.md

@@ -0,0 +1,275 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / HeadProps
+
+# Interface: HeadProps
+
+Type definition for the properties.
+
+## Extends
+
+- [`LinkListProps`](LinkListProps.md).[`MetaListProps`](MetaListProps.md).[`OgpProps`](OgpProps.md).[`TitleProps`](TitleProps.md).`Except`\<[`XCardProps`](XCardProps.md), `"image"`\>
+
+## Properties
+
+### author?
+
+> `readonly` `optional` **author**: `string`
+
+The author of the meta tag.
+
+#### Inherited from
+
+[`MetaListProps`](MetaListProps.md).[`author`](MetaListProps.md#author)
+
+***
+
+### authorUrl?
+
+> `readonly` `optional` **authorUrl**: `string`
+
+The author URL.
+
+#### Inherited from
+
+[`LinkListProps`](LinkListProps.md).[`authorUrl`](LinkListProps.md#authorurl)
+
+***
+
+### colorDark?
+
+> `readonly` `optional` **colorDark**: `string`
+
+The color of the meta tag on the dark mode.
+
+#### Inherited from
+
+[`MetaListProps`](MetaListProps.md).[`colorDark`](MetaListProps.md#colordark)
+
+***
+
+### colorLight?
+
+> `readonly` `optional` **colorLight**: `string`
+
+The color of the meta tag on the light mode.
+
+#### Inherited from
+
+[`MetaListProps`](MetaListProps.md).[`colorLight`](MetaListProps.md#colorlight)
+
+***
+
+### description?
+
+> `readonly` `optional` **description**: `string`
+
+The description of the meta tag.
+
+#### Inherited from
+
+[`MetaListProps`](MetaListProps.md).[`description`](MetaListProps.md#description)
+
+***
+
+### faviconType?
+
+> `readonly` `optional` **faviconType**: `string`
+
+The mime type of the favicon.
+
+#### Inherited from
+
+[`LinkListProps`](LinkListProps.md).[`faviconType`](LinkListProps.md#favicontype)
+
+***
+
+### faviconUrl?
+
+> `readonly` `optional` **faviconUrl**: `string`
+
+The favicon URL.
+
+#### Inherited from
+
+[`LinkListProps`](LinkListProps.md).[`faviconUrl`](LinkListProps.md#faviconurl)
+
+***
+
+### imageAlt?
+
+> `readonly` `optional` **imageAlt**: `string`
+
+The alt text of the images.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`imageAlt`](OgpProps.md#imagealt)
+
+***
+
+### imageHeight?
+
+> `readonly` `optional` **imageHeight**: `string` \| `number`
+
+The height of the images.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`imageHeight`](OgpProps.md#imageheight)
+
+***
+
+### images?
+
+> `readonly` `optional` **images**: readonly `string`[]
+
+The image URLs of the page.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`images`](OgpProps.md#images)
+
+***
+
+### imageType?
+
+> `readonly` `optional` **imageType**: `string`
+
+The mime type of the images.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`imageType`](OgpProps.md#imagetype)
+
+***
+
+### imageWidth?
+
+> `readonly` `optional` **imageWidth**: `string` \| `number`
+
+The width of the images.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`imageWidth`](OgpProps.md#imagewidth)
+
+***
+
+### keywords?
+
+> `readonly` `optional` **keywords**: `string`
+
+The keywords of the meta tag.
+
+#### Inherited from
+
+[`MetaListProps`](MetaListProps.md).[`keywords`](MetaListProps.md#keywords)
+
+***
+
+### language?
+
+> `readonly` `optional` **language**: `string`
+
+The language of the page.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`language`](OgpProps.md#language)
+
+***
+
+### licenseUrl?
+
+> `readonly` `optional` **licenseUrl**: `string`
+
+The license URL.
+
+#### Inherited from
+
+[`LinkListProps`](LinkListProps.md).[`licenseUrl`](LinkListProps.md#licenseurl)
+
+***
+
+### next?
+
+> `readonly` `optional` **next**: `string`
+
+The next page URL.
+
+#### Inherited from
+
+[`LinkListProps`](LinkListProps.md).[`next`](LinkListProps.md#next)
+
+***
+
+### preloadImages?
+
+> `readonly` `optional` **preloadImages**: readonly `string`[]
+
+The images to preload.
+
+#### Inherited from
+
+[`LinkListProps`](LinkListProps.md).[`preloadImages`](LinkListProps.md#preloadimages)
+
+***
+
+### prev?
+
+> `readonly` `optional` **prev**: `string`
+
+The previous page URL.
+
+#### Inherited from
+
+[`LinkListProps`](LinkListProps.md).[`prev`](LinkListProps.md#prev)
+
+***
+
+### robots?
+
+> `readonly` `optional` **robots**: readonly [`Robots`](../type-aliases/Robots.md)[]
+
+#### Inherited from
+
+[`MetaListProps`](MetaListProps.md).[`robots`](MetaListProps.md#robots)
+
+***
+
+### siteName
+
+> `readonly` **siteName**: `string`
+
+The site name.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`siteName`](OgpProps.md#sitename)
+
+***
+
+### title?
+
+> `readonly` `optional` **title**: `string`
+
+The title of the page.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`title`](OgpProps.md#title)
+
+***
+
+### url?
+
+> `readonly` `optional` **url**: `string`
+
+The URL of the page.
+
+#### Inherited from
+
+[`OgpProps`](OgpProps.md).[`url`](OgpProps.md#url)

package/docs/interfaces/LinkListProps.md

@@ -0,0 +1,69 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / LinkListProps
+
+# Interface: LinkListProps
+
+Type definition for the properties.
+
+## Extended by
+
+- [`HeadProps`](HeadProps.md)
+
+## Properties
+
+### authorUrl?
+
+> `readonly` `optional` **authorUrl**: `string`
+
+The author URL.
+
+***
+
+### faviconType?
+
+> `readonly` `optional` **faviconType**: `string`
+
+The mime type of the favicon.
+
+***
+
+### faviconUrl?
+
+> `readonly` `optional` **faviconUrl**: `string`
+
+The favicon URL.
+
+***
+
+### licenseUrl?
+
+> `readonly` `optional` **licenseUrl**: `string`
+
+The license URL.
+
+***
+
+### next?
+
+> `readonly` `optional` **next**: `string`
+
+The next page URL.
+
+***
+
+### preloadImages?
+
+> `readonly` `optional` **preloadImages**: readonly `string`[]
+
+The images to preload.
+
+***
+
+### prev?
+
+> `readonly` `optional` **prev**: `string`
+
+The previous page URL.

package/docs/interfaces/MetaListProps.md

@@ -0,0 +1,59 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / MetaListProps
+
+# Interface: MetaListProps
+
+Type definition for the properties.
+
+## Extended by
+
+- [`HeadProps`](HeadProps.md)
+
+## Properties
+
+### author?
+
+> `readonly` `optional` **author**: `string`
+
+The author of the meta tag.
+
+***
+
+### colorDark?
+
+> `readonly` `optional` **colorDark**: `string`
+
+The color of the meta tag on the dark mode.
+
+***
+
+### colorLight?
+
+> `readonly` `optional` **colorLight**: `string`
+
+The color of the meta tag on the light mode.
+
+***
+
+### description?
+
+> `readonly` `optional` **description**: `string`
+
+The description of the meta tag.
+
+***
+
+### keywords?
+
+> `readonly` `optional` **keywords**: `string`
+
+The keywords of the meta tag.
+
+***
+
+### robots?
+
+> `readonly` `optional` **robots**: readonly [`Robots`](../type-aliases/Robots.md)[]

package/docs/interfaces/OgpProps.md

@@ -0,0 +1,93 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / OgpProps
+
+# Interface: OgpProps
+
+Type definition for the properties.
+
+## Extended by
+
+- [`HeadProps`](HeadProps.md)
+
+## Properties
+
+### description?
+
+> `readonly` `optional` **description**: `string`
+
+The description of the page.
+
+***
+
+### imageAlt?
+
+> `readonly` `optional` **imageAlt**: `string`
+
+The alt text of the images.
+
+***
+
+### imageHeight?
+
+> `readonly` `optional` **imageHeight**: `string` \| `number`
+
+The height of the images.
+
+***
+
+### images?
+
+> `readonly` `optional` **images**: readonly `string`[]
+
+The image URLs of the page.
+
+***
+
+### imageType?
+
+> `readonly` `optional` **imageType**: `string`
+
+The mime type of the images.
+
+***
+
+### imageWidth?
+
+> `readonly` `optional` **imageWidth**: `string` \| `number`
+
+The width of the images.
+
+***
+
+### language?
+
+> `readonly` `optional` **language**: `string`
+
+The language of the page.
+
+***
+
+### siteName
+
+> `readonly` **siteName**: `string`
+
+The site name.
+
+***
+
+### title?
+
+> `readonly` `optional` **title**: `string`
+
+The title of the page.
+
+***
+
+### url?
+
+> `readonly` `optional` **url**: `string`
+
+The URL of the page.

package/docs/interfaces/TitleProps.md

@@ -0,0 +1,29 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / TitleProps
+
+# Interface: TitleProps
+
+Type definition for the properties.
+
+## Extended by
+
+- [`HeadProps`](HeadProps.md)
+
+## Properties
+
+### siteName
+
+> `readonly` **siteName**: `string`
+
+The site name.
+
+***
+
+### title?
+
+> `readonly` `optional` **title**: `string`
+
+The title of the page.

package/docs/interfaces/XCardProps.md

@@ -0,0 +1,49 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / XCardProps
+
+# Interface: XCardProps
+
+Type definition for the properties.
+
+## Properties
+
+### author?
+
+> `readonly` `optional` **author**: `string`
+
+The author of the meta tag.
+
+***
+
+### description?
+
+> `readonly` `optional` **description**: `string`
+
+The card description.
+
+***
+
+### image?
+
+> `readonly` `optional` **image**: `string`
+
+The card image URL.
+
+***
+
+### siteName
+
+> `readonly` **siteName**: `string`
+
+The site name.
+
+***
+
+### title?
+
+> `readonly` `optional` **title**: `string`
+
+The title of the page.

package/docs/type-aliases/AccessorObject.md

@@ -0,0 +1,38 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / AccessorObject
+
+# Type Alias: AccessorObject\<T, K\>
+
+> **AccessorObject**\<`T`, `K`\> = `Simplify`\<`{ readonly [P in K]: Accessor<T> }` & `` { readonly [P in K as `set${Capitalize<P>}`]: Setter<T> } ``\>
+
+Type definition for an object with accessor and setter properties.
+
+## Type Parameters
+
+### T
+
+`T`
+
+The type of the accessor and setter values.
+
+### K
+
+`K` *extends* `string`
+
+The keys of the object.
+
+## Example
+
+```ts
+type UserAccessorObject = AccessorObject<User, 'name' | 'age'>;
+
+const user: UserAccessorObject = {
+  name: () => 'Alice',
+  setName: (newName) => { ... },
+  age: () => 42,
+  setAge: (newAge) => { ... },
+};
+```

package/docs/type-aliases/Robots.md

@@ -0,0 +1,9 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / Robots
+
+# Type Alias: Robots
+
+> **Robots** = `"all"` \| `"follow"` \| `"index"` \| `"indexifembedded"` \| \`max-image-preview: $\{"large" \| "none" \| "standard"\}\` \| `` `max-snippet: ${number}` `` \| `` `max-video-preview: ${number}` `` \| `"noarchive"` \| `"nofollow"` \| `"noimageindex"` \| `"noindex"` \| `"none"` \| `"nosnippet"` \| `"notranslate"` \| `` `unavailable_after: ${string}` ``

package/docs/variables/Head.md

@@ -0,0 +1,40 @@
+[**@kurone-kito/web-toybox-solid**](../README.md)
+
+***
+
+[@kurone-kito/web-toybox-solid](../globals.md) / Head
+
+# Variable: Head
+
+> `const` **Head**: `Component`\<[`HeadProps`](../interfaces/HeadProps.md)\>
+
+The head metadata component.
+
+## Param
+
+The properties.
+
+## Returns
+
+The component.
+
+## Example
+
+```tsx
+<Head
+  author="John Doe"
+  colorDark="#000000"
+  colorLight="#FFFFFF"
+  description="This is a sample description."
+  images={['https://example.com/image.png']}
+  links={[
+    { rel: 'icon', href: '/favicon.ico' },
+    { rel: 'stylesheet', href: 'https://example.com/styles.css' },
+  ]}
+  keywords="sample, meta, tags"
+  siteName="Example Site"
+  title="Sample Page"
+  type="website"
+  url="https://example.com/page"
+/>
+```