Site Documentation

Appearance

web

web / lib/hooks/useListingForm.svelte / useListingForm

Function: useListingForm() ​

useListingForm(defaults?, isEdit?): object

Defined in: lib/hooks/useListingForm.svelte.ts:185

Parameters ​

defaults? ​

ListingFormDefaults = {}

isEdit? ​

boolean = false

Returns ​

object

getSnapshot ​

getSnapshot: () => object

Returns ​

object

additional_details ​

additional_details: string

address ​

address: AddressState | null

all_financials_verified ​

all_financials_verified: boolean

audited ​

audited: boolean

badges ​

badges: string[]

business_hours ​

business_hours: string

confidential_sale ​

confidential_sale: boolean

contact_company ​

contact_company: string

contact_email ​

contact_email: string

contact_method ​

contact_method: string

contact_name ​

contact_name: string

contact_phone ​

contact_phone: string

contact_role ​

contact_role: string

customer_type ​

customer_type: string

date_established ​

date_established: string

deal_type ​

deal_type: string

description ​

description: string

desired_selling_price ​

desired_selling_price: string

ebitda ​

ebitda: number | null

gross_margin ​

gross_margin: number | null

has_valuation_firm ​

has_valuation_firm: boolean

hide_asking_price ​

hide_asking_price: boolean

is_online_listing ​

is_online_listing: boolean

is_public ​

is_public: boolean

keywords ​

keywords: string[]

market ​

market: string

monthly_recurring_revenue ​

monthly_recurring_revenue: number | null

naics_code ​

naics_code: string

name ​

name: string

number_of_employees ​

number_of_employees: number | null

number_of_managers ​

number_of_managers: number | null

number_of_owners ​

number_of_owners: number | null

ownership_type ​

ownership_type: string

pcs_code ​

pcs_code: string

preferred_contact ​

preferred_contact: string

private_listing ​

private_listing: boolean

reason_for_sale ​

reason_for_sale: string

requires_daily_owner_involvement ​

requires_daily_owner_involvement: boolean

show_valuation_estimate ​

show_valuation_estimate: boolean

status ​

status: string

timeframe_to_sell ​

timeframe_to_sell: string

ttm_gross_profit ​

ttm_gross_profit: number | null

ttm_pre_tax_net_income ​

ttm_pre_tax_net_income: number | null

ttm_revenue ​

ttm_revenue: number | null

type_of_sale ​

type_of_sale: string

valuation_estimate ​

valuation_estimate: string

website ​

website: string

will_stay_post_sale ​

will_stay_post_sale: boolean

yearly_growth_rate ​

yearly_growth_rate: string

years_in_operation ​

years_in_operation: number | null

getValue ​

getValue: (key) => unknown

Parameters ​

key ​

string

Returns ​

unknown

goTo ​

goTo: (step) => void

Parameters ​

step ​

number

Returns ​

void

next ​

next: () => void

Returns ​

void

prev ​

prev: () => void

Returns ​

void

setValue ​

setValue: (key, value) => void

Parameters ​

key ​

string

value ​

unknown

Returns ​

void

currentStep ​

Get Signature ​

get currentStep(): number

Returns ​

number

errors ​

Get Signature ​

get errors(): Partial<Record<string, string>>

Returns ​

Partial<Record<string, string>>

fields ​

Get Signature ​

get fields(): ListingFormField[]

Returns ​

ListingFormField[]

is_online_listing ​

Get Signature ​

get is_online_listing(): boolean

Returns ​

boolean

isFirstStep ​

Get Signature ​

get isFirstStep(): boolean

Returns ​

boolean

isLastStep ​

Get Signature ​

get isLastStep(): boolean

Returns ​

boolean

isReviewStep ​

Get Signature ​

get isReviewStep(): boolean

Returns ​

boolean

isValid ​

Get Signature ​

get isValid(): boolean

Returns ​

boolean

progress ​

Get Signature ​

get progress(): number

Returns ​

number

steps ​

Get Signature ​

get steps(): StepMeta[]

Returns ​

StepMeta[]

stepSubtitle ​

Get Signature ​

get stepSubtitle(): string

Returns ​

string

stepTitle ​

Get Signature ​

get stepTitle(): string

Returns ​

string

submitAttempted ​

Get Signature ​

get submitAttempted(): boolean

Returns ​

boolean

validationErrors ​

Get Signature ​

get validationErrors(): Partial<Record<string, string>>

Returns ​

Partial<Record<string, string>>

_setSubmitAttempted() ​

_setSubmitAttempted(v): void

Parameters ​

v ​

boolean

Returns ​

void