index.d.ts 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. import * as vue from "vue";
  2. //#region ../../packages/hooks/use-aria/index.d.ts
  3. interface AriaProps {
  4. /**
  5. * @description native `aria-label` attribute
  6. */
  7. ariaLabel?: string;
  8. /**
  9. * @description native `aria-orientation` attribute
  10. */
  11. ariaOrientation?: 'horizontal' | 'vertical' | 'undefined';
  12. /**
  13. * @description native `aria-controls` attribute
  14. */
  15. ariaControls?: string;
  16. }
  17. /**
  18. * @deprecated Removed after 3.0.0, Use `AriaProps` instead.
  19. */
  20. declare const ariaProps: {
  21. ariaLabel: StringConstructor;
  22. ariaOrientation: {
  23. readonly type: vue.PropType<string>;
  24. readonly required: false;
  25. readonly validator: ((val: unknown) => boolean) | undefined;
  26. __epPropKey: true;
  27. };
  28. ariaControls: StringConstructor;
  29. };
  30. declare const useAriaProps: <T extends keyof typeof ariaProps>(arias: Array<T>) => Pick<{
  31. ariaLabel: StringConstructor;
  32. ariaOrientation: {
  33. readonly type: vue.PropType<string>;
  34. readonly required: false;
  35. readonly validator: ((val: unknown) => boolean) | undefined;
  36. __epPropKey: true;
  37. };
  38. ariaControls: StringConstructor;
  39. }, T>;
  40. //#endregion
  41. export { AriaProps, ariaProps, useAriaProps };