@conform-to/react 1.18.0 → 1.19.0

package/dist/helpers.d.ts

@@ -85,7 +85,7 @@ export declare function getAriaAttributes(metadata: Metadata<any, any, any>, opt
  * Derives the properties of a form element based on the form metadata,
  * including `id`, `onSubmit`, `noValidate`, and `aria-describedby`.
  *
- * @example
+ * **Example:**
  * ```tsx
  * <form {...getFormProps(metadata)} />
  * ```
@@ -101,7 +101,7 @@ export declare function getFormProps<Schema extends Record<string, any>, FormErr
  * Derives the properties of a fieldset element based on the field metadata,
  * including `id`, `name`, `form`, and `aria-describedby`.
  *
- * @example
+ * **Example:**
  * ```tsx
  * <fieldset {...getFieldsetProps(metadata)} />
  * ```
@@ -125,8 +125,9 @@ export declare function getFormControlProps<Schema>(metadata: FieldMetadata<Sche
  * Depends on the provided options, it will also set `defaultChecked` / `checked` if it is a checkbox or radio button,
  * or otherwise `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getInputProps
- * @example
+ * See https://conform.guide/api/react/getInputProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled input
  * <input {...getInputProps(metadata, { type: 'text' })} />
@@ -145,8 +146,9 @@ export declare function getInputProps<Schema, Options extends InputOptions>(meta
  * and constraint attributes such as `required` or `multiple`.
  * Depends on the provided options, it will also set `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getSelectProps
- * @example
+ * See https://conform.guide/api/react/getSelectProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled select
  * <select {...getSelectProps(metadata)} />
@@ -161,8 +163,9 @@ export declare function getSelectProps<Schema>(metadata: FieldMetadata<Schema, a
  * and constraint attributes such as `required`, `minLength` or `maxLength`.
  * Depends on the provided options, it will also set `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getTextareaProps
- * @example
+ * See https://conform.guide/api/react/getTextareaProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled textarea
  * <textarea {...getTextareaProps(metadata)} />
@@ -175,8 +178,9 @@ export declare function getTextareaProps<Schema>(metadata: FieldMetadata<Schema,
  * Derives the properties of a collection of checkboxes or radio buttons based on the field metadata,
  * including common form control attributes like `key`, `id`, `name`, `form`, `autoFocus`, `aria-invalid`, `aria-describedby` and `required`.
  *
- * @see https://conform.guide/api/react/getCollectionProps
- * @example
+ * See https://conform.guide/api/react/getCollectionProps
+ *
+ * **Example:**
  * ```tsx
  * <fieldset>
  *   {getCollectionProps(metadata, {

package/dist/helpers.js

@@ -38,7 +38,7 @@ function getAriaAttributes(metadata) {
  * Derives the properties of a form element based on the form metadata,
  * including `id`, `onSubmit`, `noValidate`, and `aria-describedby`.
  *
- * @example
+ * **Example:**
  * ```tsx
  * <form {...getFormProps(metadata)} />
  * ```
@@ -55,7 +55,7 @@ function getFormProps(metadata, options) {
  * Derives the properties of a fieldset element based on the field metadata,
  * including `id`, `name`, `form`, and `aria-describedby`.
  *
- * @example
+ * **Example:**
  * ```tsx
  * <fieldset {...getFieldsetProps(metadata)} />
  * ```
@@ -87,8 +87,9 @@ function getFormControlProps(metadata, options) {
  * Depends on the provided options, it will also set `defaultChecked` / `checked` if it is a checkbox or radio button,
  * or otherwise `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getInputProps
- * @example
+ * See https://conform.guide/api/react/getInputProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled input
  * <input {...getInputProps(metadata, { type: 'text' })} />
@@ -129,8 +130,9 @@ function getInputProps(metadata, options) {
  * and constraint attributes such as `required` or `multiple`.
  * Depends on the provided options, it will also set `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getSelectProps
- * @example
+ * See https://conform.guide/api/react/getSelectProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled select
  * <select {...getSelectProps(metadata)} />
@@ -156,8 +158,9 @@ function getSelectProps(metadata) {
  * and constraint attributes such as `required`, `minLength` or `maxLength`.
  * Depends on the provided options, it will also set `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getTextareaProps
- * @example
+ * See https://conform.guide/api/react/getTextareaProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled textarea
  * <textarea {...getTextareaProps(metadata)} />
@@ -182,8 +185,9 @@ function getTextareaProps(metadata) {
  * Derives the properties of a collection of checkboxes or radio buttons based on the field metadata,
  * including common form control attributes like `key`, `id`, `name`, `form`, `autoFocus`, `aria-invalid`, `aria-describedby` and `required`.
  *
- * @see https://conform.guide/api/react/getCollectionProps
- * @example
+ * See https://conform.guide/api/react/getCollectionProps
+ *
+ * **Example:**
  * ```tsx
  * <fieldset>
  *   {getCollectionProps(metadata, {

package/dist/helpers.mjs

@@ -34,7 +34,7 @@ function getAriaAttributes(metadata) {
  * Derives the properties of a form element based on the form metadata,
  * including `id`, `onSubmit`, `noValidate`, and `aria-describedby`.
  *
- * @example
+ * **Example:**
  * ```tsx
  * <form {...getFormProps(metadata)} />
  * ```
@@ -51,7 +51,7 @@ function getFormProps(metadata, options) {
  * Derives the properties of a fieldset element based on the field metadata,
  * including `id`, `name`, `form`, and `aria-describedby`.
  *
- * @example
+ * **Example:**
  * ```tsx
  * <fieldset {...getFieldsetProps(metadata)} />
  * ```
@@ -83,8 +83,9 @@ function getFormControlProps(metadata, options) {
  * Depends on the provided options, it will also set `defaultChecked` / `checked` if it is a checkbox or radio button,
  * or otherwise `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getInputProps
- * @example
+ * See https://conform.guide/api/react/getInputProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled input
  * <input {...getInputProps(metadata, { type: 'text' })} />
@@ -125,8 +126,9 @@ function getInputProps(metadata, options) {
  * and constraint attributes such as `required` or `multiple`.
  * Depends on the provided options, it will also set `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getSelectProps
- * @example
+ * See https://conform.guide/api/react/getSelectProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled select
  * <select {...getSelectProps(metadata)} />
@@ -152,8 +154,9 @@ function getSelectProps(metadata) {
  * and constraint attributes such as `required`, `minLength` or `maxLength`.
  * Depends on the provided options, it will also set `defaultValue` / `value`.
  *
- * @see https://conform.guide/api/react/getTextareaProps
- * @example
+ * See https://conform.guide/api/react/getTextareaProps
+ *
+ * **Example:**
  * ```tsx
  * // To setup an uncontrolled textarea
  * <textarea {...getTextareaProps(metadata)} />
@@ -178,8 +181,9 @@ function getTextareaProps(metadata) {
  * Derives the properties of a collection of checkboxes or radio buttons based on the field metadata,
  * including common form control attributes like `key`, `id`, `name`, `form`, `autoFocus`, `aria-invalid`, `aria-describedby` and `required`.
  *
- * @see https://conform.guide/api/react/getCollectionProps
- * @example
+ * See https://conform.guide/api/react/getCollectionProps
+ *
+ * **Example:**
  * ```tsx
  * <fieldset>
  *   {getCollectionProps(metadata, {

package/package.json

@@ -3,7 +3,7 @@
   "description": "Conform view adapter for react",
   "homepage": "https://conform.guide",
   "license": "MIT",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -41,7 +41,7 @@
     "url": "https://github.com/edmundhung/conform/issues"
   },
   "dependencies": {
-    "@conform-to/dom": "1.18.0"
+    "@conform-to/dom": "1.19.0"
   },
   "devDependencies": {
     "@babel/core": "^7.17.8",