grassroot
Install

DocsAPI referenceHeadlesscoupon-input

coupon-input headless API

The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.

Machine API

@grassroot/ui-headless-core/coupon-input

Core connector and vanilla API

14 exports
View source packages/ui-headless/core/src/coupon-input/index.ts

connectCouponInput

function
DeclarationView source
connectCouponInputts
declare function connectCouponInput(service: CouponInputService, scope: PartScope, options?: CouponInputConnectOptions): CouponInputApi;
Name
Kind
Type
Requirement
service
parameter
CouponInputService
required
scope
parameter
PartScope
required
options
parameter
CouponInputConnectOptions
optional
return
return value
CouponInputApi
n/a
Name
service
Kind
parameter
Type
CouponInputService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
CouponInputConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
CouponInputApi
Requirement
n/a

couponInputAnatomy

value
DeclarationView source
couponInputAnatomyts
export declare const couponInputAnatomy: {
  readonly scope: "coupon-input";
  readonly parts: readonly ["root", "input", "submit", "message"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "input", "submit", "message"]
required
scope
property
"coupon-input"
required
Name
parts
Kind
property
Type
readonly ["root", "input", "submit", "message"]
Requirement
required
Name
scope
Kind
property
Type
"coupon-input"
Requirement
required

CouponInputApi

interface
DeclarationView source
CouponInputApits
interface CouponInputApi {
  rootProps(): PartProps;
  inputProps(): PartProps;
  submitProps(): PartProps;
  messageProps(): PartProps;
  syncNativeState(): void;
  applySucceeded(): void;
  applyFailed(): void;
  reset(): void;
  readonly code: string;
  readonly pending: boolean;
  readonly status: CouponInputContext["status"];
}
Name
Kind
Type
Requirement
applyFailed
method
() => void
required
applySucceeded
method
() => void
required
code
property
string
required
inputProps
method
() => PartProps
required
messageProps
method
() => PartProps
required
pending
property
boolean
required
reset
method
() => void
required
rootProps
method
() => PartProps
required
status
property
CouponInputContext["status"]
required
submitProps
method
() => PartProps
required
syncNativeState
method
() => void
required
Name
applyFailed
Kind
method
Type
() => void
Requirement
required
Name
applySucceeded
Kind
method
Type
() => void
Requirement
required
Name
code
Kind
property
Type
string
Requirement
required
Name
inputProps
Kind
method
Type
() => PartProps
Requirement
required
Name
messageProps
Kind
method
Type
() => PartProps
Requirement
required
Name
pending
Kind
property
Type
boolean
Requirement
required
Name
reset
Kind
method
Type
() => void
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
status
Kind
property
Type
CouponInputContext["status"]
Requirement
required
Name
submitProps
Kind
method
Type
() => PartProps
Requirement
required
Name
syncNativeState
Kind
method
Type
() => void
Requirement
required

CouponInputApplyDetail

interface
DeclarationView source
CouponInputApplyDetailts
interface CouponInputApplyDetail {
  readonly code: string;
}
Name
Kind
Type
Requirement
code
property
string
required
Name
code
Kind
property
Type
string
Requirement
required

CouponInputCodeChangeDetail

interface
DeclarationView source
CouponInputCodeChangeDetailts
interface CouponInputCodeChangeDetail {
  readonly code: string;
}
Name
Kind
Type
Requirement
code
property
string
required
Name
code
Kind
property
Type
string
Requirement
required

CouponInputConnectOptions

interface
DeclarationView source
CouponInputConnectOptionsts
interface CouponInputConnectOptions {
  readonly ariaLabel?: string;
  readonly message?: string;
  readonly messages?: Partial<CouponInputMessages>;
  readonly onApply?: (detail: CouponInputApplyDetail) => void;
  readonly onCodeChange?: (detail: CouponInputCodeChangeDetail) => void;
}
Name
Kind
Type
Requirement
ariaLabel
property
string
optional
message
property
string
optional
messages
property
Partial<CouponInputMessages>
optional
onApply
property
(detail: CouponInputApplyDetail) => void
optional
onCodeChange
property
(detail: CouponInputCodeChangeDetail) => void
optional
Name
ariaLabel
Kind
property
Type
string
Requirement
optional
Name
message
Kind
property
Type
string
Requirement
optional
Name
messages
Kind
property
Type
Partial<CouponInputMessages>
Requirement
optional
Name
onApply
Kind
property
Type
(detail: CouponInputApplyDetail) => void
Requirement
optional
Name
onCodeChange
Kind
property
Type
(detail: CouponInputCodeChangeDetail) => void
Requirement
optional

couponInputMessages

value
DeclarationView source
couponInputMessagests
export declare const couponInputMessages: CouponInputMessages;

CouponInputMessages

type
DeclarationView source
CouponInputMessagests
type CouponInputMessages = Pick<MessageTable, "inputLabel">;

CouponInputMount

interface
DeclarationView source
CouponInputMountts
interface CouponInputMount {
  readonly service: CouponInputService;
  readonly connector: CouponInputApi;
  readonly root: HTMLElement;
  readonly input: HTMLInputElement;
  readonly submit: HTMLButtonElement;
  readonly message: HTMLSpanElement;
  destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
CouponInputApi
required
destroy
method
() => void
required
input
property
HTMLInputElement
required
message
property
HTMLSpanElement
required
root
property
HTMLElement
required
service
property
CouponInputService
required
submit
property
HTMLButtonElement
required
Name
connector
Kind
property
Type
CouponInputApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
input
Kind
property
Type
HTMLInputElement
Requirement
required
Name
message
Kind
property
Type
HTMLSpanElement
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
CouponInputService
Requirement
required
Name
submit
Kind
property
Type
HTMLButtonElement
Requirement
required

CouponInputPart

type
DeclarationView source
CouponInputPartts
type CouponInputPart = (typeof couponInputAnatomy.parts)[number];

CouponInputService

type
DeclarationView source
CouponInputServicets
type CouponInputService = Service<CouponInputInput, "ready", CouponInputContext, CouponInputEvent, CouponInputCommand>;

mountCouponInput

function
DeclarationView source
mountCouponInputts
declare function mountCouponInput(container: HTMLElement, options?: MountCouponInputOptions): CouponInputMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountCouponInputOptions
optional
return
return value
CouponInputMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountCouponInputOptions
Requirement
optional
Name
return
Kind
return value
Type
CouponInputMount
Requirement
n/a

MountCouponInputOptions

interface
DeclarationView source
MountCouponInputOptionsts
interface MountCouponInputOptions extends CouponInputInput, CouponInputConnectOptions {
  readonly message?: string;
}
Name
Kind
Type
Requirement
message
property
string
optional
Name
message
Kind
property
Type
string
Requirement
optional

runCouponInputCommand

function
DeclarationView source
runCouponInputCommandts
declare function runCouponInputCommand(command: CouponInputCommand, options?: CouponInputConnectOptions): void;
Name
Kind
Type
Requirement
command
parameter
CouponInputCommand
required
options
parameter
CouponInputConnectOptions
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
CouponInputCommand
Requirement
required
Name
options
Kind
parameter
Type
CouponInputConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

Framework adapters

Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.

React example follows below.

React imports

@grassroot/ui-headless-react/coupon-inputts
import { Message, Root, RootProvider, Submit } from "@grassroot/ui-headless-react/coupon-input";

Vue imports

@grassroot/ui-headless-vue/coupon-inputts
<script setup lang="ts">
import { CouponInputMessage, CouponInputRoot, CouponInputRootProvider, CouponInputSubmit, Message, Root, RootProvider, Submit } from "@grassroot/ui-headless-vue/coupon-input";
</script>

Angular imports

@grassroot/ui-headless-angular/coupon-inputts
import { GrCouponInputMessage, GrCouponInputRoot, GrCouponInputSubmit, Message, Root, Submit } from "@grassroot/ui-headless-angular/coupon-input";

Svelte imports

@grassroot/ui-headless-svelte/coupon-inputts
<script lang="ts">
  import { Message, Root, RootProvider, Submit } from "@grassroot/ui-headless-svelte/coupon-input";
</script>

Solid imports

@grassroot/ui-headless-solid/coupon-inputts
import { Message, Root, RootProvider, Submit } from "@grassroot/ui-headless-solid/coupon-input";

@grassroot/ui-headless-react/coupon-input

React adapter

12 exports
View source packages/ui-headless/react/src/coupon-input/index.ts

CouponInputInputProps

interface
DeclarationView source
CouponInputInputPropsts
interface CouponInputInputProps extends InputHTMLAttributes<HTMLInputElement> {}

CouponInputMessageProps

interface
DeclarationView source
CouponInputMessagePropsts
interface CouponInputMessageProps extends HTMLAttributes<HTMLSpanElement> {}

CouponInputRootProps

interface
DeclarationView source
CouponInputRootPropsts
interface CouponInputRootProps extends Omit<HTMLAttributes<HTMLDivElement>, "defaultValue" | "id">, CouponInputInput, UseCouponInputOptions {
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
children
property
ReactNode
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional

CouponInputSubmitProps

interface
DeclarationView source
CouponInputSubmitPropsts
interface CouponInputSubmitProps extends ButtonHTMLAttributes<HTMLButtonElement> {}

Input

value
DeclarationView source
Inputts
export declare const Input: import("react").ForwardRefExoticComponent<CouponInputInputProps & import("react").RefAttributes<HTMLInputElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Message

value
DeclarationView source
Messagets
export declare const Message: import("react").ForwardRefExoticComponent<CouponInputMessageProps & import("react").RefAttributes<HTMLSpanElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<CouponInputRootProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("react").ForwardRefExoticComponent<{
  readonly value: UseCouponInputResult;
  readonly children?: ReactNode;
} & HTMLAttributes<HTMLDivElement> & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Submit

value
DeclarationView source
Submitts
export declare const Submit: import("react").ForwardRefExoticComponent<CouponInputSubmitProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

useCouponInput

function
DeclarationView source
useCouponInputts
declare function useCouponInput(input: CouponInputInput, options?: UseCouponInputOptions): UseCouponInputResult;
Name
Kind
Type
Requirement
input
parameter
CouponInputInput
required
options
parameter
UseCouponInputOptions
optional
return
return value
UseCouponInputResult
n/a
Name
input
Kind
parameter
Type
CouponInputInput
Requirement
required
Name
options
Kind
parameter
Type
UseCouponInputOptions
Requirement
optional
Name
return
Kind
return value
Type
UseCouponInputResult
Requirement
n/a

UseCouponInputOptions

interface
DeclarationView source
UseCouponInputOptionsts
interface UseCouponInputOptions extends CouponInputConnectOptions {
  readonly id?: string;
}
Name
Kind
Type
Requirement
id
property
string
optional
Name
id
Kind
property
Type
string
Requirement
optional

UseCouponInputResult

interface
DeclarationView source
UseCouponInputResultts
interface UseCouponInputResult {
  readonly service: CouponInputService;
  readonly connector: CouponInputApi;
  readonly scope: PartScope;
  readonly snapshot: CouponInputSnapshot;
}
Name
Kind
Type
Requirement
connector
property
CouponInputApi
required
scope
property
PartScope
required
service
property
CouponInputService
required
snapshot
property
CouponInputSnapshot
required
Name
connector
Kind
property
Type
CouponInputApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
CouponInputService
Requirement
required
Name
snapshot
Kind
property
Type
CouponInputSnapshot
Requirement
required

@grassroot/ui-headless-vue/coupon-input

Vue adapter

12 exports
View source packages/ui-headless/vue/src/coupon-input/index.ts

CouponInputInput

value
DeclarationView source
CouponInputInputts
export declare const CouponInputInput: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

CouponInputMessage

value
DeclarationView source
CouponInputMessagets
export declare const CouponInputMessage: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

CouponInputRoot

value
DeclarationView source
CouponInputRootts
export declare const CouponInputRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  code: StringConstructor;
  defaultCode: StringConstructor;
  pending: BooleanConstructor;
  status: PropType<CouponInputStatus>;
  ariaLabel: StringConstructor;
  message: StringConstructor;
  id: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  apply: (_detail: CouponInputApplyDetail) => true;
  codeChange: (_detail: {
    readonly code: string;
  }) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  code: StringConstructor;
  defaultCode: StringConstructor;
  pending: BooleanConstructor;
  status: PropType<CouponInputStatus>;
  ariaLabel: StringConstructor;
  message: StringConstructor;
  id: StringConstructor;
}>> & Readonly<{
  onApply?: ((_detail: CouponInputApplyDetail) => any) | undefined;
  onCodeChange?: ((_detail: {
    readonly code: string;
  }) => any) | undefined;
}>, {
  pending: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

CouponInputRootProvider

value
DeclarationView source
CouponInputRootProviderts
export declare const CouponInputRootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  value: {
    type: PropType<UseCouponInputResult>;
    required: true;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  value: {
    type: PropType<UseCouponInputResult>;
    required: true;
  };
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

CouponInputSubmit

value
DeclarationView source
CouponInputSubmitts
export declare const CouponInputSubmit: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

Input

value
DeclarationView source
Inputts
export declare const Input: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

Message

value
DeclarationView source
Messagets
export declare const Message: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

Root

value
DeclarationView source
Rootts
export declare const Root: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  code: StringConstructor;
  defaultCode: StringConstructor;
  pending: BooleanConstructor;
  status: PropType<CouponInputStatus>;
  ariaLabel: StringConstructor;
  message: StringConstructor;
  id: StringConstructor;
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  apply: (_detail: CouponInputApplyDetail) => true;
  codeChange: (_detail: {
    readonly code: string;
  }) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  code: StringConstructor;
  defaultCode: StringConstructor;
  pending: BooleanConstructor;
  status: PropType<CouponInputStatus>;
  ariaLabel: StringConstructor;
  message: StringConstructor;
  id: StringConstructor;
}>> & Readonly<{
  onApply?: ((_detail: CouponInputApplyDetail) => any) | undefined;
  onCodeChange?: ((_detail: {
    readonly code: string;
  }) => any) | undefined;
}>, {
  pending: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  value: {
    type: PropType<UseCouponInputResult>;
    required: true;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  value: {
    type: PropType<UseCouponInputResult>;
    required: true;
  };
}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

Submit

value
DeclarationView source
Submitts
export declare const Submit: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

useCouponInput

function
DeclarationView source
useCouponInputts
declare function useCouponInput(input: () => CouponInputInput, options?: () => CouponInputOptions): UseCouponInputResult;
Name
Kind
Type
Requirement
input
parameter
() => CouponInputInput
required
options
parameter
() => CouponInputOptions
optional
return
return value
UseCouponInputResult
n/a
Name
input
Kind
parameter
Type
() => CouponInputInput
Requirement
required
Name
options
Kind
parameter
Type
() => CouponInputOptions
Requirement
optional
Name
return
Kind
return value
Type
UseCouponInputResult
Requirement
n/a

UseCouponInputResult

interface
DeclarationView source
UseCouponInputResultts
interface UseCouponInputResult {
  readonly service: CouponInputService;
  readonly connector: CouponInputApi;
  readonly scope: PartScope;
  readonly snapshot: ShallowRef<CouponInputSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
CouponInputApi
required
scope
property
PartScope
required
service
property
CouponInputService
required
snapshot
property
ShallowRef<CouponInputSnapshot>
required
Name
connector
Kind
property
Type
CouponInputApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
CouponInputService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<CouponInputSnapshot>
Requirement
required

@grassroot/ui-headless-angular/coupon-input

Angular adapter

10 exports
View source packages/ui-headless/angular/src/coupon-input/index.ts

CouponInputStore

interface
DeclarationView source
CouponInputStorets
export interface CouponInputStore {
    readonly service: CouponInputService;
    readonly connector: CouponInputApi;
    readonly scope: PartScope;
    readonly version: WritableSignal<number>;
    start(): void;
    stop(): void;
    sync(input: Record<string, unknown>): void;
    syncOptions(options: Record<string, unknown>): void;
}
Name
Kind
Type
Requirement
connector
property
CouponInputApi
required
scope
property
PartScope
required
service
property
CouponInputService
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: Record<string, unknown>) => void
required
syncOptions
method
(options: Record<string, unknown>) => void
required
version
property
WritableSignal<number>
required
Name
connector
Kind
property
Type
CouponInputApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
CouponInputService
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: Record<string, unknown>) => void
Requirement
required
Name
syncOptions
Kind
method
Type
(options: Record<string, unknown>) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required

createCouponInputStore

function
DeclarationView source
createCouponInputStorets
export declare function createCouponInputStore(initial: CouponInputInput, options?: CouponInputConnectOptions): CouponInputStore;
Name
Kind
Type
Requirement
initial
parameter
CouponInputInput
required
options
parameter
CouponInputConnectOptions
optional
return
return value
CouponInputStore
n/a
Name
initial
Kind
parameter
Type
CouponInputInput
Requirement
required
Name
options
Kind
parameter
Type
CouponInputConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
CouponInputStore
Requirement
n/a

GrCouponInputInput

class
DeclarationView source
GrCouponInputInputts
export declare class GrCouponInputInput implements OnDestroy {
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumer;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputInput, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrCouponInputInput, "[grCouponInputInput]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCouponInputInput, "[grCouponInputInput]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputInput, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrCouponInputInput, "[grCouponInputInput]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputInput, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrCouponInputMessage

class
DeclarationView source
GrCouponInputMessagets
export declare class GrCouponInputMessage implements OnDestroy {
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumer;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputMessage, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrCouponInputMessage, "[grCouponInputMessage]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCouponInputMessage, "[grCouponInputMessage]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputMessage, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrCouponInputMessage, "[grCouponInputMessage]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputMessage, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrCouponInputRoot

class
DeclarationView source
GrCouponInputRootts
export declare class GrCouponInputRoot implements OnDestroy {
    readonly code: import("@angular/core").InputSignal<string | undefined>;
    readonly defaultCode: import("@angular/core").InputSignal<string | undefined>;
    readonly pending: import("@angular/core").InputSignal<boolean>;
    readonly status: import("@angular/core").InputSignal<CouponInputStatus | undefined>;
    readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
    readonly valueChange: import("@angular/core").OutputEmitterRef<{
        readonly code: string;
    }>;
    readonly apply: import("@angular/core").OutputEmitterRef<CouponInputApplyDetail>;
    readonly store: CouponInputStore;
    private readonly host;
    private readonly listeners;
    private readonly consumer;
    private last;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputRoot, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<GrCouponInputRoot, "gr-coupon-input-root", never, { "code": { "alias": "code"; "required": false; "isSignal": true; }; "defaultCode": { "alias": "defaultCode"; "required": false; "isSignal": true; }; "pending": { "alias": "pending"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "apply": "apply"; }, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
apply
property
import("@angular/core").OutputEmitterRef<CouponInputApplyDetail>
required
ariaLabel
property
import("@angular/core").InputSignal<string | undefined>
required
code
property
import("@angular/core").InputSignal<string | undefined>
required
consumer
property
any
required
defaultCode
property
import("@angular/core").InputSignal<string | undefined>
required
host
property
any
required
last
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrCouponInputRoot, "gr-coupon-input-root", never, { "code": { "alias": "code"; "required": false; "isSignal": true; }; "defaultCode": { "alias": "defaultCode"; "required": false; "isSignal": true; }; "pending": { "alias": "pending"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "apply": "apply"; }, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputRoot, never>
required
pending
property
import("@angular/core").InputSignal<boolean>
required
status
property
import("@angular/core").InputSignal<CouponInputStatus | undefined>
required
store
property
CouponInputStore
required
Name
apply
Kind
property
Type
import("@angular/core").OutputEmitterRef<CouponInputApplyDetail>
Requirement
required
Name
ariaLabel
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
code
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
defaultCode
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
host
Kind
property
Type
any
Requirement
required
Name
last
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrCouponInputRoot, "gr-coupon-input-root", never, { "code": { "alias": "code"; "required": false; "isSignal": true; }; "defaultCode": { "alias": "defaultCode"; "required": false; "isSignal": true; }; "pending": { "alias": "pending"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "apply": "apply"; }, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputRoot, never>
Requirement
required
Name
pending
Kind
property
Type
import("@angular/core").InputSignal<boolean>
Requirement
required
Name
status
Kind
property
Type
import("@angular/core").InputSignal<CouponInputStatus | undefined>
Requirement
required
Name
store
Kind
property
Type
CouponInputStore
Requirement
required
Name
valueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<{ readonly code: string; }>
Requirement
required

GrCouponInputSubmit

class
DeclarationView source
GrCouponInputSubmitts
export declare class GrCouponInputSubmit implements OnDestroy {
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumer;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputSubmit, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrCouponInputSubmit, "[grCouponInputSubmit]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCouponInputSubmit, "[grCouponInputSubmit]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputSubmit, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrCouponInputSubmit, "[grCouponInputSubmit]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputSubmit, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

Input

class
DeclarationView source
Inputts
export declare class GrCouponInputInput implements OnDestroy {
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumer;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputInput, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrCouponInputInput, "[grCouponInputInput]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCouponInputInput, "[grCouponInputInput]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputInput, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrCouponInputInput, "[grCouponInputInput]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputInput, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

Message

class
DeclarationView source
Messagets
export declare class GrCouponInputMessage implements OnDestroy {
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumer;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputMessage, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrCouponInputMessage, "[grCouponInputMessage]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCouponInputMessage, "[grCouponInputMessage]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputMessage, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrCouponInputMessage, "[grCouponInputMessage]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputMessage, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

Root

class
DeclarationView source
Rootts
export declare class GrCouponInputRoot implements OnDestroy {
    readonly code: import("@angular/core").InputSignal<string | undefined>;
    readonly defaultCode: import("@angular/core").InputSignal<string | undefined>;
    readonly pending: import("@angular/core").InputSignal<boolean>;
    readonly status: import("@angular/core").InputSignal<CouponInputStatus | undefined>;
    readonly ariaLabel: import("@angular/core").InputSignal<string | undefined>;
    readonly valueChange: import("@angular/core").OutputEmitterRef<{
        readonly code: string;
    }>;
    readonly apply: import("@angular/core").OutputEmitterRef<CouponInputApplyDetail>;
    readonly store: CouponInputStore;
    private readonly host;
    private readonly listeners;
    private readonly consumer;
    private last;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputRoot, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<GrCouponInputRoot, "gr-coupon-input-root", never, { "code": { "alias": "code"; "required": false; "isSignal": true; }; "defaultCode": { "alias": "defaultCode"; "required": false; "isSignal": true; }; "pending": { "alias": "pending"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "apply": "apply"; }, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
apply
property
import("@angular/core").OutputEmitterRef<CouponInputApplyDetail>
required
ariaLabel
property
import("@angular/core").InputSignal<string | undefined>
required
code
property
import("@angular/core").InputSignal<string | undefined>
required
consumer
property
any
required
defaultCode
property
import("@angular/core").InputSignal<string | undefined>
required
host
property
any
required
last
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrCouponInputRoot, "gr-coupon-input-root", never, { "code": { "alias": "code"; "required": false; "isSignal": true; }; "defaultCode": { "alias": "defaultCode"; "required": false; "isSignal": true; }; "pending": { "alias": "pending"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "apply": "apply"; }, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputRoot, never>
required
pending
property
import("@angular/core").InputSignal<boolean>
required
status
property
import("@angular/core").InputSignal<CouponInputStatus | undefined>
required
store
property
CouponInputStore
required
Name
apply
Kind
property
Type
import("@angular/core").OutputEmitterRef<CouponInputApplyDetail>
Requirement
required
Name
ariaLabel
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
code
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
defaultCode
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required
Name
host
Kind
property
Type
any
Requirement
required
Name
last
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrCouponInputRoot, "gr-coupon-input-root", never, { "code": { "alias": "code"; "required": false; "isSignal": true; }; "defaultCode": { "alias": "defaultCode"; "required": false; "isSignal": true; }; "pending": { "alias": "pending"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, { "valueChange": "valueChange"; "apply": "apply"; }, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputRoot, never>
Requirement
required
Name
pending
Kind
property
Type
import("@angular/core").InputSignal<boolean>
Requirement
required
Name
status
Kind
property
Type
import("@angular/core").InputSignal<CouponInputStatus | undefined>
Requirement
required
Name
store
Kind
property
Type
CouponInputStore
Requirement
required
Name
valueChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<{ readonly code: string; }>
Requirement
required

Submit

class
DeclarationView source
Submitts
export declare class GrCouponInputSubmit implements OnDestroy {
    private readonly store;
    private readonly element;
    private readonly listeners;
    private readonly consumer;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrCouponInputSubmit, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrCouponInputSubmit, "[grCouponInputSubmit]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumer
property
any
required
element
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrCouponInputSubmit, "[grCouponInputSubmit]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrCouponInputSubmit, never>
required
store
property
any
required
Name
consumer
Kind
property
Type
any
Requirement
required
Name
element
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrCouponInputSubmit, "[grCouponInputSubmit]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrCouponInputSubmit, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

@grassroot/ui-headless-svelte/coupon-input

Svelte adapter

8 exports
View source packages/ui-headless/svelte/src/coupon-input/index.ts

createCouponInput

function
DeclarationView source
createCouponInputts
export declare function createCouponInput(input: () => CouponInputInput, options?: UseCouponInputOptions): UseCouponInputResult;
Name
Kind
Type
Requirement
input
parameter
() => CouponInputInput
required
options
parameter
UseCouponInputOptions
optional
return
return value
UseCouponInputResult
n/a
Name
input
Kind
parameter
Type
() => CouponInputInput
Requirement
required
Name
options
Kind
parameter
Type
UseCouponInputOptions
Requirement
optional
Name
return
Kind
return value
Type
UseCouponInputResult
Requirement
n/a

Input

value
DeclarationView source
Inputts
export declare const Input: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

Message

value
DeclarationView source
Messagets
export declare const Message: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

Root

value
DeclarationView source
Rootts
export declare const Root: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

RootProvider

value
DeclarationView source
RootProviderts
export declare const RootProvider: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

Submit

value
DeclarationView source
Submitts
export declare const Submit: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

UseCouponInputOptions

interface
DeclarationView source
UseCouponInputOptionsts
export interface UseCouponInputOptions extends CouponInputConnectOptions {
    readonly id?: string;
}
Name
Kind
Type
Requirement
id
property
string
optional
Name
id
Kind
property
Type
string
Requirement
optional

UseCouponInputResult

interface
DeclarationView source
UseCouponInputResultts
export interface UseCouponInputResult {
    readonly service: CouponInputService;
    readonly connector: CouponInputApi;
    readonly scope: ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>;
    readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
CouponInputApi
required
scope
property
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
required
service
property
CouponInputService
required
version
property
() => number
required
Name
connector
Kind
property
Type
CouponInputApi
Requirement
required
Name
scope
Kind
property
Type
ReturnType<typeof import("@grassroot/ui-headless-core").createPartScope>
Requirement
required
Name
service
Kind
property
Type
CouponInputService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

@grassroot/ui-headless-solid/coupon-input

Solid adapter

9 exports
View source packages/ui-headless/solid/src/coupon-input/index.ts

CouponInputRootProps

interface
DeclarationView source
CouponInputRootPropsts
export interface CouponInputRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "id">, CouponInputInput, CouponInputConnectOptions {
    readonly id?: string;
    readonly children?: JSX.Element;
}
Name
Kind
Type
Requirement
children
property
JSX.Element
optional
id
property
string
optional
Name
children
Kind
property
Type
JSX.Element
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional

Input

function
DeclarationView source
Inputts
export declare function Input(props: JSX.InputHTMLAttributes<HTMLInputElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.InputHTMLAttributes<HTMLInputElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.InputHTMLAttributes<HTMLInputElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Message

function
DeclarationView source
Messagets
export declare function Message(props: JSX.HTMLAttributes<HTMLSpanElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLSpanElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLSpanElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Root

function
DeclarationView source
Rootts
export declare function Root(props: CouponInputRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
CouponInputRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
CouponInputRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

RootProvider

function
DeclarationView source
RootProviderts
export declare function RootProvider(props: {
    readonly value: UseCouponInputResult;
    readonly children?: JSX.Element;
} & JSX.HTMLAttributes<HTMLDivElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
{ readonly value: UseCouponInputResult; readonly children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
{ readonly value: UseCouponInputResult; readonly children?: JSX.Element; } & JSX.HTMLAttributes<HTMLDivElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

Submit

function
DeclarationView source
Submitts
export declare function Submit(props: JSX.ButtonHTMLAttributes<HTMLButtonElement>): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.ButtonHTMLAttributes<HTMLButtonElement>
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.ButtonHTMLAttributes<HTMLButtonElement>
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

useCouponInput

function
DeclarationView source
useCouponInputts
export declare function useCouponInput(input: Accessor<CouponInputInput>, options?: UseCouponInputOptions): UseCouponInputResult;
Name
Kind
Type
Requirement
input
parameter
Accessor<CouponInputInput>
required
options
parameter
UseCouponInputOptions
optional
return
return value
UseCouponInputResult
n/a
Name
input
Kind
parameter
Type
Accessor<CouponInputInput>
Requirement
required
Name
options
Kind
parameter
Type
UseCouponInputOptions
Requirement
optional
Name
return
Kind
return value
Type
UseCouponInputResult
Requirement
n/a

UseCouponInputOptions

interface
DeclarationView source
UseCouponInputOptionsts
export interface UseCouponInputOptions extends CouponInputConnectOptions {
    readonly id?: string;
}
Name
Kind
Type
Requirement
id
property
string
optional
Name
id
Kind
property
Type
string
Requirement
optional

UseCouponInputResult

interface
DeclarationView source
UseCouponInputResultts
export interface UseCouponInputResult {
    readonly service: CouponInputService;
    readonly connector: CouponInputApi;
    readonly scope: PartScope;
    readonly snapshot: () => number;
}
Name
Kind
Type
Requirement
connector
property
CouponInputApi
required
scope
property
PartScope
required
service
property
CouponInputService
required
snapshot
property
() => number
required
Name
connector
Kind
property
Type
CouponInputApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
CouponInputService
Requirement
required
Name
snapshot
Kind
property
Type
() => number
Requirement
required