nuxt.schema.d.ts 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. export interface NuxtCustomSchema {
  2. appConfig?: {
  3. /**
  4. * Nuxt Icon
  5. *
  6. * Configure Nuxt Icon module preferences.
  7. *
  8. */
  9. nuxtIcon?: {
  10. /**
  11. * Icon Size
  12. *
  13. * Set the default icon size. Set to false to disable the sizing of icon in style.
  14. *
  15. * @default "1em"
  16. *
  17. * @studioIcon material-symbols:format-size-rounded
  18. */
  19. size?: string | false,
  20. /**
  21. * CSS Class
  22. *
  23. * Set the default CSS class.
  24. *
  25. * @default ""
  26. *
  27. * @studioIcon material-symbols:css
  28. */
  29. class?: string,
  30. /**
  31. * Icon aliases
  32. *
  33. * Define Icon aliases to update them easily without code changes.
  34. *
  35. *
  36. * @studioIcon material-symbols:star-rounded
  37. */
  38. aliases?: { [alias: string]: string },
  39. /**
  40. * Iconify API Options
  41. *
  42. * Define preferences for Iconify API fetch.
  43. *
  44. *
  45. * @studioIcon material-symbols:tv-options-input-settings
  46. */
  47. iconifyApiOptions?: {
  48. /**
  49. * Iconify API URL
  50. *
  51. * Define a custom Iconify API URL. Useful if you want to use a self-hosted Iconify API. Learn more: https://iconify.design/docs/api.
  52. *
  53. * @default "https://api.iconify.design"
  54. *
  55. * @studioIcon material-symbols:api
  56. */
  57. url?: string,
  58. /**
  59. * Public Iconify API fallback
  60. *
  61. * Define if the public Iconify API should be used as fallback.
  62. *
  63. * @default false
  64. *
  65. * @studioIcon material-symbols:public
  66. */
  67. publicApiFallback?: boolean,
  68. },
  69. },
  70. },
  71. }
  72. export type CustomAppConfig = Exclude<NuxtCustomSchema['appConfig'], undefined>
  73. type _CustomAppConfig = CustomAppConfig
  74. declare module '@nuxt/schema' {
  75. interface NuxtConfig extends Omit<NuxtCustomSchema, 'appConfig'> {}
  76. interface NuxtOptions extends Omit<NuxtCustomSchema, 'appConfig'> {}
  77. interface CustomAppConfig extends _CustomAppConfig {}
  78. }
  79. declare module 'nuxt/schema' {
  80. interface NuxtConfig extends Omit<NuxtCustomSchema, 'appConfig'> {}
  81. interface NuxtOptions extends Omit<NuxtCustomSchema, 'appConfig'> {}
  82. interface CustomAppConfig extends _CustomAppConfig {}
  83. }