Options
All
  • Public
  • Public/Protected
  • All
Menu

Module react-ui

Index

Namespaces

Interfaces

Type aliases

Variables

Functions

Type aliases

ButtonProps

ButtonProps: React.DetailedHTMLProps<React.HTMLAttributes<HTMLButtonElement>, HTMLButtonElement> & any

FormOption

FormOption<TField>: { checked?: boolean; disabled?: boolean; intlId?: string; label: string; value: TField }

Type parameters

  • TField = any

Type declaration

  • Optional checked?: boolean

    Can force a default value

  • Optional disabled?: boolean

    Non clickable option (visual clue)

  • Optional intlId?: string

    Translated option

  • label: string
  • value: TField

PossibleVulcanComponents

PossibleVulcanComponents: PossibleCoreComponents & PossibleFormComponents & DatatableComponents & CellComponents

SmartFormProps

SmartFormProps: FormContainerProps

Variables

Const Components

Components: {} = {}

Type declaration

Const ComponentsTable

ComponentsTable: {} = {}

Type declaration

Const FormContext

FormContext: Context<undefined | FormContextValue> = ...

Const VulcanComponentsConsumer

VulcanComponentsConsumer: Consumer<PossibleVulcanComponents> = ...

Const VulcanComponentsContext

VulcanComponentsContext: Context<PossibleVulcanComponents> = ...

Const VulcanCurrentUserConsumer

VulcanCurrentUserConsumer: Consumer<VulcanCurrentUserContextType> = ...

Const coreComponents

coreComponents: string[] = ...

Const defaultCellComponents

defaultCellComponents: {} = {}

Type declaration

Const defaultCoreComponents

defaultCoreComponents: { LoadingButton: (__namedParameters: any) => Element; MutationButton: (props: MutationButtonProps) => Element } = ...

Type declaration

Const defaultDatatableComponents

defaultDatatableComponents: {} = {}

Type declaration

Const defaultFormComponents

defaultFormComponents: Partial<PossibleFormComponents> = ...

Functions

Const Form

  • Parameters

    Returns any

Const FormContainer

  • Parameters

    Returns Element

Const LoadingButton

  • LoadingButton(__namedParameters: any): Element

  • Parameters

    • __namedParameters: any

    Returns Element

Const MutationButton

  • Parameters

    Returns Element

Const SmartForm

  • Parameters

    Returns Element

Const VulcanComponentsProvider

  • VulcanComponentsProvider(__namedParameters: { children: ReactNode; value?: Partial<PossibleVulcanComponents> }): Element

  • Parameters

    Returns Element

Const VulcanCurrentUserProvider

  • VulcanCurrentUserProvider(__namedParameters: { children: ReactNode; value: VulcanCurrentUserContextType }): Element

  • Parameters

    • __namedParameters: { children: ReactNode; value: VulcanCurrentUserContextType }
      • children: ReactNode
      • value: VulcanCurrentUserContextType

    Returns Element

Const componentExists

  • componentExists(name: any): boolean

  • Returns true if a component with the given name has been registered with registerComponent(name, component, ...hocs).

    Parameters

    • name: any

      The name of the component to get.

    Returns boolean

Const delayedComponent

  • delayedComponent(name: any): (props: any) => any

  • Creates a component that will render the registered component with the given name.

    This function may be useful when in need for some registered component, but in contexts where they have not yet been initialized, for example at compile time execution. In other words, when using Components.ComponentName is not allowed (because it has not yet been populated, hence would be undefined), then delayedComponent('ComponentName') can be used instead.

    example

    Create a container for a registered component // SomeContainer.js import compose from 'recompose/compose'; import { delayedComponent } from 'meteor/vulcan:core';

    export default compose( // ...some hocs with container logic )(delayedComponent('ComponentName')); // cannot use Components.ComponentName in this context!

    example

    {@link dynamicLoader}

    Parameters

    • name: any

      Component name

    Returns (props: any) => any

    Functional component that will render the given registered component

      • (props: any): any

      • Parameters

        • props: any

        Returns any

Const getRawComponent

  • getRawComponent(name: any): any

  • Get the raw (original) component registered with registerComponent without the possible HOCs wrapping it.

    Parameters

    • name: any

      The name of the component to get.

    Returns any

    An interchangeable/extendable React component

Const instantiateComponent

  • instantiateComponent(component?: any, props?: any): any

  • Returns an instance of the given component name of function

    Parameters

    • Optional component: any

      A component, the name of a component, or a react element

    • Optional props: any

    Returns any

Const mergeWithComponents

  • mergeWithComponents(myComponents: any): any

  • Parameters

    • myComponents: any

    Returns any

Const useFormContext

  • useFormContext(): FormContextValue

  • Returns FormContextValue

Const useVulcanComponents

Const useVulcanCurrentUser

  • useVulcanCurrentUser(): VulcanCurrentUserContextType

  • Returns VulcanCurrentUserContextType

Const withVulcanComponents

  • withVulcanComponents(C: any): (props: any) => Element

  • Parameters

    • C: any

    Returns (props: any) => Element

      • (props: any): Element

      • Parameters

        • props: any

        Returns Element

Generated using TypeDoc