@openwebf/react-cupertino-ui 0.2.3 → 0.2.5

package/dist/index.d.mts

@@ -56,8 +56,9 @@ interface FlutterCupertinoTimerPickerElement extends WebFElementWithMethods<{}>
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoTimerPicker
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoTimerPicker>
@@ -136,18 +137,37 @@ interface FlutterCupertinoTextareaProps {
      */
     className?: string;
 }
-interface FlutterCupertinoTextareaElement extends WebFElementWithMethods<{}> {
+/**
+ * Element interface with methods accessible via ref
+ * @example
+ * ```tsx
+ * const ref = useRef<FlutterCupertinoTextareaElement>(null);
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
+ * ```
+ */
+interface FlutterCupertinoTextareaElement extends WebFElementWithMethods<{
+    focus(): void;
+    blur(): void;
+    clear(): void;
+}> {
 }
 /**
  * FlutterCupertinoTextarea - WebF FlutterCupertinoTextarea component
  *
  * @example
  * ```tsx
+ * const ref = useRef<FlutterCupertinoTextareaElement>(null);
+ *
  * <FlutterCupertinoTextarea
- *   // Add example props here
+ *   ref={ref}
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoTextarea>
+ *
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
  * ```
  */
 declare const FlutterCupertinoTextarea: React.ForwardRefExoticComponent<FlutterCupertinoTextareaProps & {
@@ -205,18 +225,35 @@ interface FlutterCupertinoTabBarProps {
      */
     className?: string;
 }
-interface FlutterCupertinoTabBarElement extends WebFElementWithMethods<{}> {
+/**
+ * Element interface with methods accessible via ref
+ * @example
+ * ```tsx
+ * const ref = useRef<FlutterCupertinoTabBarElement>(null);
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
+ * ```
+ */
+interface FlutterCupertinoTabBarElement extends WebFElementWithMethods<{
+    switchTab(path: string): void;
+}> {
 }
 /**
  * FlutterCupertinoTabBar - WebF FlutterCupertinoTabBar component
  *
  * @example
  * ```tsx
+ * const ref = useRef<FlutterCupertinoTabBarElement>(null);
+ *
  * <FlutterCupertinoTabBar
- *   // Add example props here
+ *   ref={ref}
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoTabBar>
+ *
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
  * ```
  */
 declare const FlutterCupertinoTabBar: React.ForwardRefExoticComponent<FlutterCupertinoTabBarProps & {
@@ -260,8 +297,9 @@ interface FlutterCupertinoTabBarItemElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoTabBarItem
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoTabBarItem>
@@ -291,17 +329,16 @@ interface FlutterCupertinoTabProps {
      */
     className?: string;
 }
-interface FlutterCupertinoTabElement extends WebFElementWithMethods<{
-    switchTab(index: number): void;
-}> {
+interface FlutterCupertinoTabElement extends WebFElementWithMethods<{}> {
 }
 /**
  * FlutterCupertinoTab - WebF FlutterCupertinoTab component
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoTab
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoTab>
@@ -338,8 +375,9 @@ interface FlutterCupertinoTabItemElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoTabItem
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoTabItem>
@@ -396,8 +434,9 @@ interface FlutterCupertinoSwitchElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoSwitch
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoSwitch>
@@ -460,18 +499,36 @@ interface FlutterCupertinoSliderProps {
      */
     className?: string;
 }
-interface FlutterCupertinoSliderElement extends WebFElementWithMethods<{}> {
+/**
+ * Element interface with methods accessible via ref
+ * @example
+ * ```tsx
+ * const ref = useRef<FlutterCupertinoSliderElement>(null);
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
+ * ```
+ */
+interface FlutterCupertinoSliderElement extends WebFElementWithMethods<{
+    getValue(): number;
+    setValue(val: number): void;
+}> {
 }
 /**
  * FlutterCupertinoSlider - WebF FlutterCupertinoSlider component
  *
  * @example
  * ```tsx
+ * const ref = useRef<FlutterCupertinoSliderElement>(null);
+ *
  * <FlutterCupertinoSlider
- *   // Add example props here
+ *   ref={ref}
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoSlider>
+ *
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
  * ```
  */
 declare const FlutterCupertinoSlider: React.ForwardRefExoticComponent<FlutterCupertinoSliderProps & {
@@ -555,18 +612,39 @@ interface FlutterCupertinoSearchInputProps {
      */
     className?: string;
 }
-interface FlutterCupertinoSearchInputElement extends WebFElementWithMethods<{}> {
+/**
+ * Element interface with methods accessible via ref
+ * @example
+ * ```tsx
+ * const ref = useRef<FlutterCupertinoSearchInputElement>(null);
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
+ * ```
+ */
+interface FlutterCupertinoSearchInputElement extends WebFElementWithMethods<{
+    getValue(): string;
+    setValue(value: string): void;
+    focus(): void;
+    blur(): void;
+    clear(): void;
+}> {
 }
 /**
  * FlutterCupertinoSearchInput - WebF FlutterCupertinoSearchInput component
  *
  * @example
  * ```tsx
+ * const ref = useRef<FlutterCupertinoSearchInputElement>(null);
+ *
  * <FlutterCupertinoSearchInput
- *   // Add example props here
+ *   ref={ref}
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoSearchInput>
+ *
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
  * ```
  */
 declare const FlutterCupertinoSearchInput: React.ForwardRefExoticComponent<FlutterCupertinoSearchInputProps & {
@@ -630,8 +708,9 @@ interface FlutterCupertinoRadioElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoRadio
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoRadio>
@@ -678,8 +757,9 @@ interface FlutterCupertinoPickerElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoPicker
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoPicker>
@@ -741,8 +821,9 @@ interface FlutterCupertinoModalPopupElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoModalPopup
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoModalPopup>
@@ -815,18 +896,38 @@ interface FlutterCupertinoInputProps {
      */
     className?: string;
 }
-interface FlutterCupertinoInputElement extends WebFElementWithMethods<{}> {
+/**
+ * Element interface with methods accessible via ref
+ * @example
+ * ```tsx
+ * const ref = useRef<FlutterCupertinoInputElement>(null);
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
+ * ```
+ */
+interface FlutterCupertinoInputElement extends WebFElementWithMethods<{
+    getValue(): string;
+    setValue(value: string): void;
+    focus(): void;
+    blur(): void;
+}> {
 }
 /**
  * FlutterCupertinoInput - WebF FlutterCupertinoInput component
  *
  * @example
  * ```tsx
+ * const ref = useRef<FlutterCupertinoInputElement>(null);
+ *
  * <FlutterCupertinoInput
- *   // Add example props here
+ *   ref={ref}
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoInput>
+ *
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
  * ```
  */
 declare const FlutterCupertinoInput: React.ForwardRefExoticComponent<FlutterCupertinoInputProps & {
@@ -866,8 +967,9 @@ interface FlutterCupertinoIconElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoIcon
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoIcon>
@@ -959,8 +1061,9 @@ interface FlutterCupertinoDatePickerElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoDatePicker
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoDatePicker>
@@ -972,6 +1075,13 @@ declare const FlutterCupertinoDatePicker: React.ForwardRefExoticComponent<Flutte
     children?: React.ReactNode;
 } & React.RefAttributes<FlutterCupertinoDatePickerElement>>;
 
+interface ContextMenuAction {
+    text: string;
+    icon?: string;
+    destructive?: boolean;
+    default?: boolean;
+    event?: string;
+}
 interface FlutterCupertinoContextMenuProps {
     /**
      * enableHapticFeedback property
@@ -991,18 +1101,35 @@ interface FlutterCupertinoContextMenuProps {
      */
     className?: string;
 }
-interface FlutterCupertinoContextMenuElement extends WebFElementWithMethods<{}> {
+/**
+ * Element interface with methods accessible via ref
+ * @example
+ * ```tsx
+ * const ref = useRef<FlutterCupertinoContextMenuElement>(null);
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
+ * ```
+ */
+interface FlutterCupertinoContextMenuElement extends WebFElementWithMethods<{
+    setActions(actions: ContextMenuAction[]): void;
+}> {
 }
 /**
  * FlutterCupertinoContextMenu - WebF FlutterCupertinoContextMenu component
  *
  * @example
  * ```tsx
+ * const ref = useRef<FlutterCupertinoContextMenuElement>(null);
+ *
  * <FlutterCupertinoContextMenu
- *   // Add example props here
+ *   ref={ref}
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoContextMenu>
+ *
+ * // Call methods on the element
+ * ref.current?.finishRefresh('success');
  * ```
  */
 declare const FlutterCupertinoContextMenu: React.ForwardRefExoticComponent<FlutterCupertinoContextMenuProps & {
@@ -1071,8 +1198,9 @@ interface FlutterCupertinoCheckboxElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoCheckbox
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoCheckbox>
@@ -1129,8 +1257,9 @@ interface FlutterCupertinoButtonElement extends WebFElementWithMethods<{}> {
  *
  * @example
  * ```tsx
+ *
  * <FlutterCupertinoButton
- *   // Add example props here
+ *   // Add props here
  * >
  *   Content
  * </FlutterCupertinoButton>