kdutify 0.16.9-rc.0 → 2.6.0

package/types/lib.d.ts

@@ -0,0 +1,376 @@
+declare module 'kdutify/lib' {
+  import Kdutify from 'kdutify'
+  import { Colors } from 'kdutify/lib/util/colors'
+
+  export default Kdutify
+
+  const colors: Colors
+
+  export {
+    colors,
+  }
+  export * from 'kdutify/lib/components'
+  export * from 'kdutify/lib/directives'
+}
+
+declare module 'kdutify/lib/components' {
+  import { KduConstructor } from 'kdu'
+
+  const KApp: KduConstructor
+  const KAppBar: KduConstructor
+  const KAppBarNavIcon: KduConstructor
+  const KAppBarTitle: KduConstructor
+  const KAlert: KduConstructor
+  const KAutocomplete: KduConstructor
+  const KAvatar: KduConstructor
+  const KBadge: KduConstructor
+  const KBanner: KduConstructor
+  const KBottomNavigation: KduConstructor
+  const KBottomSheet: KduConstructor
+  const KBreadcrumbs: KduConstructor
+  const KBreadcrumbsItem: KduConstructor
+  const KBreadcrumbsDivider: KduConstructor
+  const KBtn: KduConstructor
+  const KBtnToggle: KduConstructor
+  const KCalendar: KduConstructor
+  const KCalendarCategory: KduConstructor
+  const KCalendarDaily: KduConstructor
+  const KCalendarWeekly: KduConstructor
+  const KCalendarMonthly: KduConstructor
+  const KCard: KduConstructor
+  const KCardTitle: KduConstructor
+  const KCardSubtitle: KduConstructor
+  const KCardActions: KduConstructor
+  const KCardText: KduConstructor
+  const KCarousel: KduConstructor
+  const KCarouselItem: KduConstructor
+  const KCheckbox: KduConstructor
+  const KSimpleCheckbox: KduConstructor
+  const KChip: KduConstructor
+  const KChipGroup: KduConstructor
+  const KColorPicker: KduConstructor
+  const KColorPickerSwatches: KduConstructor
+  const KColorPickerCanvas: KduConstructor
+  const KContent: KduConstructor
+  const KCombobox: KduConstructor
+  const KCounter: KduConstructor
+  const KData: KduConstructor
+  const KDataIterator: KduConstructor
+  const KDataFooter: KduConstructor
+  const KDataTable: KduConstructor
+  const KEditDialog: KduConstructor
+  const KTableOverflow: KduConstructor
+  const KDataTableHeader: KduConstructor
+  const KSimpleTable: KduConstructor
+  const KVirtualTable: KduConstructor
+  const KVirtualScroll: KduConstructor
+  const KDatePicker: KduConstructor
+  const KDatePickerTitle: KduConstructor
+  const KDatePickerHeader: KduConstructor
+  const KDatePickerDateTable: KduConstructor
+  const KDatePickerMonthTable: KduConstructor
+  const KDatePickerYears: KduConstructor
+  const KDialog: KduConstructor
+  const KDivider: KduConstructor
+  const KExpansionPanels: KduConstructor
+  const KExpansionPanel: KduConstructor
+  const KExpansionPanelHeader: KduConstructor
+  const KExpansionPanelContent: KduConstructor
+  const KFileInput: KduConstructor
+  const KFooter: KduConstructor
+  const KForm: KduConstructor
+  const KContainer: KduConstructor
+  const KCol: KduConstructor
+  const KRow: KduConstructor
+  const KSpacer: KduConstructor
+  const KLayout: KduConstructor
+  const KFlex: KduConstructor
+  const KHover: KduConstructor
+  const KIcon: KduConstructor
+  const KImg: KduConstructor
+  const KInput: KduConstructor
+  const KItem: KduConstructor
+  const KItemGroup: KduConstructor
+  const KLabel: KduConstructor
+  const KLazy: KduConstructor
+  const KListItemActionText: KduConstructor
+  const KListItemContent: KduConstructor
+  const KListItemTitle: KduConstructor
+  const KListItemSubtitle: KduConstructor
+  const KList: KduConstructor
+  const KListGroup: KduConstructor
+  const KListItem: KduConstructor
+  const KListItemAction: KduConstructor
+  const KListItemAvatar: KduConstructor
+  const KListItemIcon: KduConstructor
+  const KListItemGroup: KduConstructor
+  const KMain: KduConstructor
+  const KMenu: KduConstructor
+  const KMessages: KduConstructor
+  const KNavigationDrawer: KduConstructor
+  const KOverflowBtn: KduConstructor
+  const KOverlay: KduConstructor
+  const KPagination: KduConstructor
+  const KSheet: KduConstructor
+  const KParallax: KduConstructor
+  const KPicker: KduConstructor
+  const KProgressCircular: KduConstructor
+  const KProgressLinear: KduConstructor
+  const KRadioGroup: KduConstructor
+  const KRadio: KduConstructor
+  const KRangeSlider: KduConstructor
+  const KRating: KduConstructor
+  const KResponsive: KduConstructor
+  const KSelect: KduConstructor
+  const KSkeletonLoader: KduConstructor
+  const KSlider: KduConstructor
+  const KSlideGroup: KduConstructor
+  const KSlideItem: KduConstructor
+  const KSnackbar: KduConstructor
+  const KSparkline: KduConstructor
+  const KSpeedDial: KduConstructor
+  const KStepper: KduConstructor
+  const KStepperContent: KduConstructor
+  const KStepperStep: KduConstructor
+  const KStepperHeader: KduConstructor
+  const KStepperItems: KduConstructor
+  const KSubheader: KduConstructor
+  const KSwitch: KduConstructor
+  const KSystemBar: KduConstructor
+  const KTabs: KduConstructor
+  const KTab: KduConstructor
+  const KTabItem: KduConstructor
+  const KTabsItems: KduConstructor
+  const KTabsSlider: KduConstructor
+  const KTextarea: KduConstructor
+  const KTextField: KduConstructor
+  const KThemeProvider: KduConstructor
+  const KTimeline: KduConstructor
+  const KTimelineItem: KduConstructor
+  const KTimePicker: KduConstructor
+  const KTimePickerClock: KduConstructor
+  const KTimePickerTitle: KduConstructor
+  const KToolbar: KduConstructor
+  const KToolbarItems: KduConstructor
+  const KToolbarTitle: KduConstructor
+  const KTooltip: KduConstructor
+  const KTreeview: KduConstructor
+  const KTreeviewNode: KduConstructor
+  const KWindow: KduConstructor
+  const KWindowItem: KduConstructor
+  const KCarouselTransition: KduConstructor
+  const KCarouselReverseTransition: KduConstructor
+  const KTabTransition: KduConstructor
+  const KTabReverseTransition: KduConstructor
+  const KMenuTransition: KduConstructor
+  const KFabTransition: KduConstructor
+  const KDialogTransition: KduConstructor
+  const KDialogBottomTransition: KduConstructor
+  const KDialogTopTransition: KduConstructor
+  const KFadeTransition: KduConstructor
+  const KScaleTransition: KduConstructor
+  const KScrollXTransition: KduConstructor
+  const KScrollXReverseTransition: KduConstructor
+  const KScrollYTransition: KduConstructor
+  const KScrollYReverseTransition: KduConstructor
+  const KSlideXTransition: KduConstructor
+  const KSlideXReverseTransition: KduConstructor
+  const KSlideYTransition: KduConstructor
+  const KSlideYReverseTransition: KduConstructor
+  const KExpandTransition: KduConstructor
+  const KExpandXTransition: KduConstructor
+
+  export {
+    KApp,
+    KAppBar,
+    KAppBarNavIcon,
+    KAppBarTitle,
+    KAlert,
+    KAutocomplete,
+    KAvatar,
+    KBadge,
+    KBanner,
+    KBottomNavigation,
+    KBottomSheet,
+    KBreadcrumbs,
+    KBreadcrumbsItem,
+    KBreadcrumbsDivider,
+    KBtn,
+    KBtnToggle,
+    KCalendar,
+    KCalendarCategory,
+    KCalendarDaily,
+    KCalendarWeekly,
+    KCalendarMonthly,
+    KCard,
+    KCardTitle,
+    KCardSubtitle,
+    KCardActions,
+    KCardText,
+    KCarousel,
+    KCarouselItem,
+    KCheckbox,
+    KSimpleCheckbox,
+    KChip,
+    KChipGroup,
+    KColorPicker,
+    KColorPickerSwatches,
+    KColorPickerCanvas,
+    KContent,
+    KCombobox,
+    KCounter,
+    KData,
+    KDataIterator,
+    KDataFooter,
+    KDataTable,
+    KEditDialog,
+    KTableOverflow,
+    KDataTableHeader,
+    KSimpleTable,
+    KVirtualTable,
+    KVirtualScroll,
+    KDatePicker,
+    KDatePickerTitle,
+    KDatePickerHeader,
+    KDatePickerDateTable,
+    KDatePickerMonthTable,
+    KDatePickerYears,
+    KDialog,
+    KDivider,
+    KExpansionPanels,
+    KExpansionPanel,
+    KExpansionPanelHeader,
+    KExpansionPanelContent,
+    KFileInput,
+    KFooter,
+    KForm,
+    KContainer,
+    KCol,
+    KRow,
+    KSpacer,
+    KLayout,
+    KFlex,
+    KHover,
+    KIcon,
+    KImg,
+    KInput,
+    KItem,
+    KItemGroup,
+    KLabel,
+    KLazy,
+    KListItemActionText,
+    KListItemContent,
+    KListItemTitle,
+    KListItemSubtitle,
+    KList,
+    KListGroup,
+    KListItem,
+    KListItemAction,
+    KListItemAvatar,
+    KListItemIcon,
+    KListItemGroup,
+    KMain,
+    KMenu,
+    KMessages,
+    KNavigationDrawer,
+    KOverflowBtn,
+    KOverlay,
+    KPagination,
+    KSheet,
+    KParallax,
+    KPicker,
+    KProgressCircular,
+    KProgressLinear,
+    KRadioGroup,
+    KRadio,
+    KRangeSlider,
+    KRating,
+    KResponsive,
+    KSelect,
+    KSkeletonLoader,
+    KSlider,
+    KSlideGroup,
+    KSlideItem,
+    KSnackbar,
+    KSparkline,
+    KSpeedDial,
+    KStepper,
+    KStepperContent,
+    KStepperStep,
+    KStepperHeader,
+    KStepperItems,
+    KSubheader,
+    KSwitch,
+    KSystemBar,
+    KTabs,
+    KTab,
+    KTabItem,
+    KTabsItems,
+    KTabsSlider,
+    KTextarea,
+    KTextField,
+    KThemeProvider,
+    KTimeline,
+    KTimelineItem,
+    KTimePicker,
+    KTimePickerClock,
+    KTimePickerTitle,
+    KToolbar,
+    KToolbarItems,
+    KToolbarTitle,
+    KTooltip,
+    KTreeview,
+    KTreeviewNode,
+    KWindow,
+    KWindowItem,
+    KCarouselTransition,
+    KCarouselReverseTransition,
+    KTabTransition,
+    KTabReverseTransition,
+    KMenuTransition,
+    KFabTransition,
+    KDialogTransition,
+    KDialogBottomTransition,
+    KDialogTopTransition,
+    KFadeTransition,
+    KScaleTransition,
+    KScrollXTransition,
+    KScrollXReverseTransition,
+    KScrollYTransition,
+    KScrollYReverseTransition,
+    KSlideXTransition,
+    KSlideXReverseTransition,
+    KSlideYTransition,
+    KSlideYReverseTransition,
+    KExpandTransition,
+    KExpandXTransition,
+  }
+}
+
+declare module 'kdutify/lib/directives' {
+  import { DirectiveOptions } from 'kdu'
+
+  const ClickOutside: DirectiveOptions
+  const Intersect: DirectiveOptions
+  const Mutate: DirectiveOptions
+  const Resize: DirectiveOptions
+  const Ripple: DirectiveOptions
+  const Scroll: DirectiveOptions
+  const Touch: DirectiveOptions
+
+  export {
+    ClickOutside,
+    Intersect,
+    Mutate,
+    Ripple,
+    Resize,
+    Scroll,
+    Touch,
+  }
+}
+
+declare module 'kdutify/lib/services/goto' {
+  import { GoToOptions, KdutifyGoToTarget } from 'kdutify/types/services/goto'
+
+  export default function goTo(target: KdutifyGoToTarget, options?: Partial<GoToOptions>): Promise<number>
+}

package/types/services/application.d.ts

@@ -0,0 +1,24 @@
+export type TargetProp = 'bar' | 'top' | 'right' | 'bottom' | 'left' | 'footer' | 'insetFooter'
+
+interface TargetPropValues {
+  [uid: number]: number
+}
+
+export interface Application {
+  bar: number
+  top: number
+  left: number
+  insetFooter: number
+  right: number
+  bottom: number
+  footer: number
+  application: Record<string, TargetPropValues>
+
+  register (
+    uid: number,
+    location: TargetProp,
+    size: number
+  ): void
+  unregister (uid: number, location: TargetProp): void
+  update (location: TargetProp): void
+}

package/types/services/breakpoint.d.ts

@@ -0,0 +1,42 @@
+// Types
+export type BreakpointName = 'xs' | 'sm' | 'md' | 'lg' | 'xl'
+
+// Interfaces
+export interface Breakpoint {
+  height: number
+  lg: boolean
+  lgAndDown: boolean
+  lgAndUp: boolean
+  lgOnly: boolean
+  md: boolean
+  mdAndDown: boolean
+  mdAndUp: boolean
+  mdOnly: boolean
+  name: BreakpointName
+  sm: boolean
+  smAndDown: boolean
+  smAndUp: boolean
+  smOnly: boolean
+  width: number
+  xl: boolean
+  xlOnly: boolean
+  xs: boolean
+  xsOnly: boolean
+  mobile: boolean
+  mobileBreakpoint: number | BreakpointName
+  thresholds: BreakpointThresholds
+  scrollBarWidth: number
+}
+
+export interface BreakpointOptions {
+  mobileBreakpoint?: number | BreakpointName
+  scrollBarWidth?: number
+  thresholds?: Partial<BreakpointThresholds>
+}
+
+export interface BreakpointThresholds {
+  xs: number
+  sm: number
+  md: number
+  lg: number
+}

package/types/services/goto.d.ts

@@ -0,0 +1,30 @@
+// Types
+import Kdu from 'kdu'
+
+export type KdutifyGoToTarget = number | string | HTMLElement | Kdu
+
+export type KdutifyGoToEasing =
+  ((t: number) => number) |
+  'linear' |
+  'easeInQuad' |
+  'easeOutQuad' |
+  'easeInOutQuad' |
+  'easeInCubic' |
+  'easeOutCubic' |
+  'easeInOutCubic' |
+  'easeInQuart' |
+  'easeOutQuart' |
+  'easeInOutQuart' |
+  'easeInQuint' |
+  'easeOutQuint' |
+  'easeInOutQuint'
+
+export interface GoToOptions {
+  container?: string | HTMLElement | Kdu
+  duration?: number
+  offset?: number
+  easing?: KdutifyGoToEasing
+  appOffset?: boolean
+}
+
+export default function goTo(target: KdutifyGoToTarget, options?: GoToOptions): Promise<number>

package/types/services/icons.d.ts

@@ -0,0 +1,68 @@
+// Types
+import { Component } from 'kdu'
+
+export interface Icons extends IconsOptions {
+  iconfont: Iconfont
+  values: KdutifyIcons
+}
+
+export type Iconfont = 'mdi' | 'mdiSvg' | 'md' | 'fa' | 'faSvg' | 'fa4'
+
+export interface IconsOptions {
+  component?: Component | string
+  /**
+   * Select a base icon font to use. Note that none of these are included, you must install them yourself
+   *
+   * md: <a href="https://material.io/icons">material.io</a> (default)
+   * mdi: <a href="https://materialdesignicons.com">MDI</a>
+   * fa: <a href="https://fontawesome.com/get-started/web-fonts-with-css">FontAwesome 5</a>
+   * fa4: <a href="https://fontawesome.com/v4.7.0/">FontAwesome 4</a>
+   * faSvg: <a href="https://fontawesome.com/">FontAwesome SVG</a>
+   */
+  iconfont?: Iconfont
+  values?: Partial<KdutifyIcons>
+}
+
+export type KdutifyIconComponent = {
+  component: Component | string
+  props?: object
+}
+
+export type KdutifyIcon = string | KdutifyIconComponent
+
+export interface KdutifyIcons {
+  complete: KdutifyIcon
+  cancel: KdutifyIcon
+  close: KdutifyIcon
+  delete: KdutifyIcon
+  clear: KdutifyIcon
+  success: KdutifyIcon
+  info: KdutifyIcon
+  warning: KdutifyIcon
+  error: KdutifyIcon
+  prev: KdutifyIcon
+  next: KdutifyIcon
+  checkboxOn: KdutifyIcon
+  checkboxOff: KdutifyIcon
+  checkboxIndeterminate: KdutifyIcon
+  delimiter: KdutifyIcon
+  sort: KdutifyIcon
+  expand: KdutifyIcon
+  menu: KdutifyIcon
+  subgroup: KdutifyIcon
+  dropdown: KdutifyIcon
+  radioOn: KdutifyIcon
+  radioOff: KdutifyIcon
+  edit: KdutifyIcon
+  ratingEmpty: KdutifyIcon
+  ratingFull: KdutifyIcon
+  ratingHalf: KdutifyIcon
+  loading: KdutifyIcon
+  first: KdutifyIcon
+  last: KdutifyIcon
+  unfold: KdutifyIcon
+  file: KdutifyIcon
+  plus: KdutifyIcon
+  minus: KdutifyIcon
+  [name: string]: KdutifyIcon
+}

package/types/services/index.d.ts

@@ -0,0 +1,17 @@
+// Types
+import Kdu from 'kdu'
+import Framework from '../'
+import { KdutifyPreset } from 'kdutify/types/services/presets'
+
+export interface KdutifyServiceContract {
+  framework: Record<string, KdutifyServiceContract>
+  init: (root: Kdu, ssrContext?: object) => void
+}
+
+export interface KdutifyService {
+  property: string
+  new (
+    preset: KdutifyPreset,
+    parent: InstanceType<typeof Framework>
+  ): KdutifyServiceContract
+}

package/types/services/lang.d.ts

@@ -0,0 +1,19 @@
+export interface Lang {
+  locales: LangLocales
+  current: string
+  t: LangTranslator
+}
+
+export interface LangOptions {
+  locales?: LangLocales
+  current?: string
+  t?: LangTranslator
+}
+
+// TODO: complete list of keys?
+export interface KdutifyLocale {
+  [key: string]: KdutifyLocale | string
+}
+
+export type LangLocales = Record<string, KdutifyLocale>
+export type LangTranslator = (key: string, ...params: Array<string | number>) => string

package/types/services/presets.d.ts

@@ -0,0 +1,65 @@
+import { Component } from 'kdu'
+// Services
+import {
+  Breakpoint,
+  BreakpointOptions,
+} from 'kdutify/types/services/breakpoint'
+import {
+  Icons,
+  IconsOptions,
+} from 'kdutify/types/services/icons'
+import {
+  Lang,
+  LangOptions,
+} from 'kdutify/types/services/lang'
+import {
+  Theme,
+  ThemeOptions,
+} from 'kdutify/types/services/theme'
+
+export interface KdutifyPreset {
+  breakpoint: {
+    mobileBreakpoint: Breakpoint['mobileBreakpoint']
+    scrollBarWidth: Breakpoint['scrollBarWidth']
+    thresholds: Breakpoint['thresholds']
+  }
+  icons: {
+    component?: Icons['component']
+    iconfont: Icons['iconfont']
+    // TODO: Remove partial for v3
+    values: Partial<Icons['values']>
+  }
+  lang: {
+    current: Lang['current']
+    locales: Lang['locales']
+    t: Lang['t']
+  }
+  theme: {
+    dark: Theme['dark']
+    default: Theme['default']
+    disable: Theme['disable']
+    options: Theme['options']
+    themes: Theme['themes']
+  }
+
+  [name: string]: any
+}
+
+export interface UserKdutifyPreset extends GlobalKdutifyPreset {
+  preset?: GlobalKdutifyPreset
+
+  [name: string]: any
+}
+
+export interface GlobalKdutifyPreset {
+  breakpoint?: BreakpointOptions
+  icons?: IconsOptions
+  lang?: LangOptions
+  theme?: ThemeOptions
+
+  [name: string]: any
+}
+
+export interface Presets {
+  preset: UserKdutifyPreset
+}