@dyrected/vue 2.9.0 → 2.10.1

package/dist/composables/useDyPath.d.ts

@@ -12,19 +12,45 @@ export declare const DY_PATH_KEY: InjectionKey<string>;
  */
 export declare function provideDyPath(path: string): void;
 /**
- * useDyPath — returns an attribute object annotating an element with its
+ * Function that creates `data-dy-path` props for any field relative to the current block.
+ */
+export type DyPathFn = (field?: string) => {
+    'data-dy-path': string;
+};
+/**
+ * useDyPath — returns an annotation helper or attribute object annotating an element with its
  * document value path, so the Dyrected live-preview editor can map a click in
- * the preview back to the exact field. Spread it onto the element (render
- * functions) or bind with `v-bind` in templates.
+ * the preview back to the exact field.
  *
- * Must be called in `setup()`. Authors pass only the field name relative to the
- * current block; the ancestor `<Blocks>`/`provideDyPath` supplies the base path.
+ * @overload When called with no arguments (recommended), returns a `dy` helper function:
+ * ```vue
+ * <script setup>
+ * const dy = useDyPath();
+ * </script>
+ * <template>
+ *   <h1 v-bind="dy('heading')">{{ heading }}</h1>
+ *   <p v-if="subheading" v-bind="dy('subheading')">{{ subheading }}</p>
+ *   <ul>
+ *     <li v-for="(item, idx) in items" :key="idx" v-bind="dy(`items.${idx}.title`)">
+ *       {{ item.title }}
+ *     </li>
+ *   </ul>
+ * </template>
+ * ```
  *
- * @example (render function)
- *   h('h1', useDyPath('heading'), props.heading)
- * @example (template)
+ * @overload When called with a field name, returns the attribute object directly:
+ * ```vue
+ * <template>
  *   <h1 v-bind="useDyPath('heading')">{{ heading }}</h1>
+ * </template>
+ * ```
  */
-export declare function useDyPath(field?: string): {
+export declare function useDyPath(): DyPathFn;
+export declare function useDyPath(field: string): {
     'data-dy-path': string;
 };
+/**
+ * useDyPathHelper — explicit helper that reads context once in setup() and returns
+ * a callable path generator function.
+ */
+export declare function useDyPathHelper(): DyPathFn;