mirror of
https://github.com/frappe/erpnext.git
synced 2026-05-19 21:19:19 +00:00
feat: new banking module (#54720)
* feat: initial SPA setup for banking * wip: bring over new banking module * feat: added Espresso design tokens * feat: button styles * fix: add all ink colors * wip: espresso design system changes * feat: button and badge espresso components * fix: button styling for reconcile * feat: Espresso progress bar * feat: Espresso toggle switch * feat: Espresso tabs design * fix: vertical tab support * fix: button sizing across modals * feat: Espresso style table layout * feat: Espresso tooltip * feat: Espresso elevations and checkbox * feat: Dialog with Espresso styles * feat: Espresso textarea * fix: input styles * fix: colors on bank picker * fix: breadcrumb styling * fix: bank picker styling * feat: create doctypes and fields for bank reconciliation * feat: APIs for banking * fix: use date format parser * fix: font styling to match Espresso * wip: settings modal * feat: settings dialog component * fix: icons and invalid requests * feat: preferences tab * fix: adjust icon stroke width to 1.5 * feat: rule configuration in settings * fix: remove sheet component * feat: alert and error banner component * feat: dropdown in Espresso * feat: popover and select in Espresso * fix: cleanup more styles * fix: match size of link fields * feat: command styling * fix: remove unused style tokens * fix: styles for global date picker dropdown * fix: styles for match and reconcile * feat: table Espresso component * feat: remove all other design tokens * fix: remove unused tokens * fix: form elements * fix: remove unused styles and fix filters in bank transaction list * feat: fetch bank rec doctypes for filtering * fix: record payment modal * feat: support for dark mode switching * fix: move bank logos to public folder * feat: add support for RTL * feat: support for RTL * chore: send layout direction in dev boot * fix: make checkbox work in RTL * feat: dark mode support * fix: dark mode style * feat: bank logos in dark mode * feat: dark mode bank logos * chore: use dark mode bank logos everywhere * chore: move rule evaluation to controller * chore: add tests for bank transaction rules * fix: move deps to fix actions errors * fix: move tw-animate-css to deps * fix: remove shadcn * fix: do not open modal if no transactions selected * fix: add translation strings * feat: add banner on existing bank reconciliation tool * feat: bank statement import * fix: translations and layout directions * fix: validation for transaction matching rule * fix: styles * fix: show conflicting transactions in alert * fix: show help text for new banking module forms * feat: show total debits and credits * fix: dark mode colors in automatic config * feat: add keyboard shortcuts help * feat: added keyboard shortcut for settings * fix: decrease size of progress bar * chore: bump packages * feat: add tests for statement import * fix: settings dialog * fix: show banner on small screens * fix: show banner when no bank account set
This commit is contained in:
Nikhil Kothari
383
banking/src/components/ui/form-elements.tsx
Normal file
383
banking/src/components/ui/form-elements.tsx
Normal file
@@ -0,0 +1,383 @@
|
||||
import { FieldValues, RegisterOptions, useFormContext } from "react-hook-form"
|
||||
import { FormControl, FormDescription, FormField, FormItem, FormLabel, FormMessage, FormRequiredIndicator, useFormField } from "@/components/ui/form"
|
||||
import _ from "@/lib/translate"
|
||||
import { Input } from "./input"
|
||||
import { ComponentProps, FocusEventHandler, useCallback, useState } from "react"
|
||||
import { parseDate } from "chrono-node"
|
||||
import { formatDate, getUserDateFormat, toDate } from "@/lib/date"
|
||||
import { Popover, PopoverContent, PopoverTrigger } from "./popover"
|
||||
import { Button } from "./button"
|
||||
import { CalendarIcon } from "lucide-react"
|
||||
import { Calendar } from "./calendar"
|
||||
import dayjs from "dayjs"
|
||||
import { Textarea } from "./textarea"
|
||||
import AccountsDropdown, { AccountsDropdownProps } from "../common/AccountsDropdown"
|
||||
import PartyTypeDropdown, { PartyTypeDropdownProps } from "../common/PartyTypeDropdown"
|
||||
import CurrencyInput from "react-currency-input-field"
|
||||
import { getSystemDefault } from "@/lib/frappe"
|
||||
import { getCurrencySymbol } from "@/lib/currency"
|
||||
import { getCurrencyFormatInfo } from "@/lib/numbers"
|
||||
import LinkFieldCombobox, { LinkFieldComboboxProps } from "../common/LinkFieldCombobox"
|
||||
import { Select, SelectContent, SelectTrigger, SelectValue } from "./select"
|
||||
import { InputGroup, InputGroupAddon } from "./input-group"
|
||||
|
||||
interface FormElementProps {
|
||||
name: string,
|
||||
rules?: Omit<RegisterOptions<FieldValues, string>, "disabled" | "valueAsNumber" | "valueAsDate" | "setValueAs">,
|
||||
label: string,
|
||||
isRequired?: boolean,
|
||||
disabled?: boolean,
|
||||
formDescription?: string,
|
||||
hideLabel?: boolean,
|
||||
readOnly?: boolean,
|
||||
|
||||
}
|
||||
|
||||
interface DataFieldProps extends FormElementProps {
|
||||
inputProps?: Omit<ComponentProps<"input">, "value" | "onChange" | "onBlur" | "name" | "ref">
|
||||
}
|
||||
|
||||
export const DataField = ({ name, rules, label, isRequired, formDescription, inputProps, hideLabel, disabled, readOnly }: DataFieldProps) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
return <FormField
|
||||
control={control}
|
||||
disabled={disabled}
|
||||
name={name}
|
||||
rules={rules}
|
||||
render={({ field }) => (
|
||||
<FormItem className='flex flex-col'>
|
||||
<FormLabel className={hideLabel ? 'sr-only' : ''}>{label}{isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
<FormControl>
|
||||
<Input {...field} maxLength={140} aria-readonly={readOnly} readOnly={readOnly} {...inputProps} />
|
||||
</FormControl>
|
||||
{formDescription && <FormDescription>{formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
|
||||
interface SelectFieldProps extends FormElementProps {
|
||||
children: React.ReactNode
|
||||
}
|
||||
|
||||
export const SelectFormField = ({ name, rules, label, isRequired, formDescription, hideLabel, children, disabled, readOnly }: SelectFieldProps) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
|
||||
return <FormField
|
||||
control={control}
|
||||
name={name}
|
||||
disabled={disabled}
|
||||
rules={rules}
|
||||
render={({ field }) => (
|
||||
<FormItem>
|
||||
<FormLabel className={hideLabel ? 'sr-only' : ''}>{label}{isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
<FormControl>
|
||||
<Select onValueChange={field.onChange} value={field.value} disabled={disabled || readOnly} aria-readonly={readOnly}>
|
||||
<FormControl>
|
||||
<SelectTrigger className="w-full">
|
||||
<SelectValue />
|
||||
</SelectTrigger>
|
||||
</FormControl>
|
||||
<SelectContent>
|
||||
{children}
|
||||
</SelectContent>
|
||||
</Select>
|
||||
</FormControl>
|
||||
{formDescription && <FormDescription>{formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
|
||||
interface DateFieldProps extends FormElementProps {
|
||||
inputProps?: Omit<ComponentProps<"input">, "value" | "onChange" | "onBlur" | "name" | "ref">
|
||||
}
|
||||
|
||||
export const DateField = ({ name, rules, label, isRequired, formDescription, inputProps, hideLabel, disabled }: DateFieldProps) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
|
||||
const DatePicker = ({ field }: { field: FieldValues }) => {
|
||||
|
||||
const userDateFormat = getUserDateFormat()
|
||||
const [open, setOpen] = useState(false)
|
||||
|
||||
const [value, setValue] = useState<string | undefined>(field.value ? formatDate(field.value) : undefined)
|
||||
|
||||
const date = field.value ? toDate(field.value) : undefined
|
||||
|
||||
return <div className="relative flex gap-2">
|
||||
<FormControl>
|
||||
<Input className="pe-10"
|
||||
name={field.name}
|
||||
onBlur={() => {
|
||||
setValue(formatDate(field.value))
|
||||
field.onBlur()
|
||||
}}
|
||||
placeholder={userDateFormat}
|
||||
value={value}
|
||||
onChange={(e) => {
|
||||
setValue(e.target.value)
|
||||
if (e.target.value) {
|
||||
// On change in value, try computing date usning standard formats first
|
||||
const dateObj = toDate(e.target.value, userDateFormat)
|
||||
// If we find a valid date, use it
|
||||
if (dateObj && !isNaN(dateObj.getTime())) {
|
||||
field.onChange(formatDate(dateObj, "YYYY-MM-DD"))
|
||||
} else {
|
||||
// If not, try parsing using chrono-node for things like "1st July 2025"
|
||||
const date = parseDate(e.target.value)
|
||||
if (date) {
|
||||
field.onChange(formatDate(date, "YYYY-MM-DD"))
|
||||
}
|
||||
}
|
||||
} else {
|
||||
field.onChange("")
|
||||
}
|
||||
}}
|
||||
onKeyDown={(e) => {
|
||||
if (e.key === "ArrowDown") {
|
||||
e.preventDefault()
|
||||
setOpen(true)
|
||||
}
|
||||
}}
|
||||
maxLength={140}
|
||||
{...inputProps} />
|
||||
</FormControl>
|
||||
<Popover open={open} onOpenChange={setOpen}>
|
||||
<PopoverTrigger asChild>
|
||||
<Button
|
||||
id="date-picker-button"
|
||||
variant="ghost"
|
||||
className="absolute top-1/2 ltr:right-2 rtl:left-2 size-6 -translate-y-1/2"
|
||||
>
|
||||
<CalendarIcon className="size-3.5" />
|
||||
<span className="sr-only">{_("Select date")}</span>
|
||||
</Button>
|
||||
</PopoverTrigger>
|
||||
<PopoverContent className="w-auto overflow-hidden p-0" align="center">
|
||||
<Calendar
|
||||
mode="single"
|
||||
selected={date}
|
||||
fixedWeeks
|
||||
endMonth={dayjs().add(1, "year").toDate()}
|
||||
captionLayout="dropdown"
|
||||
defaultMonth={date}
|
||||
onSelect={(date) => {
|
||||
setValue(formatDate(date))
|
||||
field.onChange(formatDate(date, "YYYY-MM-DD"))
|
||||
setOpen(false)
|
||||
}}
|
||||
/>
|
||||
</PopoverContent>
|
||||
</Popover>
|
||||
</div>
|
||||
}
|
||||
|
||||
return <FormField
|
||||
control={control}
|
||||
name={name}
|
||||
disabled={disabled}
|
||||
rules={rules}
|
||||
render={({ field }) => (
|
||||
<FormItem className='flex flex-col'>
|
||||
<FormLabel className={hideLabel ? 'sr-only' : ''}>{label}{isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
<DatePicker field={field} />
|
||||
{formDescription && <FormDescription>{formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
|
||||
|
||||
interface SmallTextFieldProps extends FormElementProps {
|
||||
inputProps?: Omit<ComponentProps<"textarea">, "value" | "onChange" | "onBlur" | "name" | "ref">
|
||||
}
|
||||
|
||||
export const SmallTextField = ({ name, rules, label, isRequired, formDescription, inputProps, hideLabel, disabled, readOnly }: SmallTextFieldProps) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
return <FormField
|
||||
control={control}
|
||||
name={name}
|
||||
disabled={disabled}
|
||||
rules={rules}
|
||||
render={({ field }) => (
|
||||
<FormItem className='flex flex-col'>
|
||||
<FormLabel className={hideLabel ? 'sr-only' : ''}>{label}{isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
<FormControl>
|
||||
<Textarea {...field} {...inputProps} readOnly={readOnly} aria-readonly={readOnly} />
|
||||
</FormControl>
|
||||
{formDescription && <FormDescription>{formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
|
||||
|
||||
interface AccountFormFieldProps extends Omit<AccountsDropdownProps, 'value' | 'onChange'>, FormElementProps {
|
||||
}
|
||||
export const AccountFormField = (props: AccountFormFieldProps) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
|
||||
return <FormField
|
||||
control={control}
|
||||
disabled={props.disabled}
|
||||
name={props.name}
|
||||
rules={props.rules}
|
||||
render={({ field }) => (
|
||||
<FormItem className='flex flex-col'>
|
||||
<FormLabel className={props.hideLabel ? 'sr-only' : ''}>{props.label}{props.isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
<AccountsDropdown {...props} value={field.value} onChange={field.onChange} useInForm readOnly={props.readOnly} />
|
||||
{props.formDescription && <FormDescription>{props.formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
|
||||
interface PartyTypeFormField extends FormElementProps {
|
||||
inputProps?: Omit<PartyTypeDropdownProps, 'value' | 'onChange'>
|
||||
}
|
||||
|
||||
export const PartyTypeFormField = ({ name, rules, label, isRequired, formDescription, hideLabel, inputProps, disabled, readOnly }: PartyTypeFormField) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
|
||||
return <FormField
|
||||
control={control}
|
||||
disabled={disabled}
|
||||
name={name}
|
||||
rules={rules}
|
||||
render={({ field }) => (
|
||||
<FormItem className='flex flex-col'>
|
||||
<FormLabel className={hideLabel ? 'sr-only' : ''}>{label}{isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
<PartyTypeDropdown {...inputProps} value={field.value} onChange={field.onChange} useInForm readOnly={readOnly} />
|
||||
{formDescription && <FormDescription>{formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
|
||||
|
||||
interface CurrencyFormFieldProps extends FormElementProps {
|
||||
currency?: string,
|
||||
style?: React.CSSProperties,
|
||||
leftSlot?: React.ReactNode,
|
||||
}
|
||||
|
||||
export const CurrencyFormField = ({ name, rules, label, isRequired, formDescription, hideLabel, currency, disabled, readOnly, style = {}, leftSlot }: CurrencyFormFieldProps) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
|
||||
const defaultCurrency = getSystemDefault("currency")
|
||||
const currencySymbol = getCurrencySymbol(currency ?? defaultCurrency)
|
||||
|
||||
|
||||
const CurrencyField = ({ field }: { field: FieldValues }) => {
|
||||
|
||||
const onFocus: FocusEventHandler<HTMLInputElement> = useCallback((e) => {
|
||||
// When the input is focused, select the text
|
||||
// A short timeout is needed so that the input selects the text after the focus event
|
||||
setTimeout(() => {
|
||||
// Check if the input is focused - do not select text if the input is not focused
|
||||
if (e.target.contains(document.activeElement)) {
|
||||
e.target.select()
|
||||
}
|
||||
}, 100)
|
||||
}, [])
|
||||
|
||||
const { formItemId } = useFormField()
|
||||
|
||||
// Get the correct separators for the currency
|
||||
const formatInfo = getCurrencyFormatInfo(currency ?? defaultCurrency)
|
||||
const groupSeparator = formatInfo.group_sep || ","
|
||||
const decimalSeparator = formatInfo.decimal_str || "."
|
||||
|
||||
return <CurrencyInput
|
||||
ref={field.ref}
|
||||
name={field.name}
|
||||
style={{
|
||||
textAlign: 'right',
|
||||
...style
|
||||
}}
|
||||
id={formItemId}
|
||||
onBlur={field.onBlur}
|
||||
disabled={field.disabled}
|
||||
readOnly={readOnly}
|
||||
aria-readonly={readOnly}
|
||||
onFocus={onFocus}
|
||||
groupSeparator={groupSeparator}
|
||||
decimalSeparator={decimalSeparator}
|
||||
placeholder={`${currencySymbol} 0${decimalSeparator}00`}
|
||||
decimalsLimit={2}
|
||||
value={field.value}
|
||||
maxLength={12}
|
||||
decimalScale={2}
|
||||
prefix={currencySymbol + " "}
|
||||
onValueChange={(v, _n, values) => {
|
||||
// If the input ends with a decimal or a decimal with trailing zeroes, store the string since we need the user to be able to type the decimals.
|
||||
// When the user eventually types the decimals or blurs out, the value is formatted anyway.
|
||||
// Otherwise store the float value
|
||||
// Check if the value ends with a decimal or a decimal with trailing zeroes
|
||||
const isDecimal = v?.endsWith(decimalSeparator) || v?.endsWith(decimalSeparator + '0')
|
||||
const newValue = isDecimal ? v : values?.float ?? ''
|
||||
field.onChange(newValue)
|
||||
}}
|
||||
customInput={Input}
|
||||
/>
|
||||
}
|
||||
|
||||
return <FormField
|
||||
control={control}
|
||||
disabled={disabled}
|
||||
name={name}
|
||||
rules={rules}
|
||||
render={({ field }) => (
|
||||
<FormItem className='flex flex-col'>
|
||||
<FormLabel className={hideLabel ? 'sr-only' : ''}>{label}{isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
|
||||
<FormControl>
|
||||
<InputGroup>
|
||||
{leftSlot && <InputGroupAddon>{leftSlot}</InputGroupAddon>}
|
||||
<CurrencyField field={field} />
|
||||
</InputGroup>
|
||||
|
||||
</FormControl>
|
||||
{formDescription && <FormDescription>{formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
|
||||
interface LinkFormFieldProps extends FormElementProps, Omit<LinkFieldComboboxProps, 'value' | 'onChange'> {
|
||||
}
|
||||
|
||||
export const LinkFormField = ({ name, rules, label, isRequired, formDescription, hideLabel, disabled, readOnly, ...inputProps }: LinkFormFieldProps) => {
|
||||
|
||||
const { control } = useFormContext()
|
||||
|
||||
return <FormField
|
||||
control={control}
|
||||
name={name}
|
||||
disabled={disabled}
|
||||
rules={rules}
|
||||
render={({ field }) => (
|
||||
<FormItem className='flex flex-col'>
|
||||
<FormLabel className={hideLabel ? 'sr-only' : ''}>{label}{isRequired && <FormRequiredIndicator />}</FormLabel>
|
||||
<LinkFieldCombobox {...inputProps} value={field.value} onChange={field.onChange} useInForm disabled={disabled} readOnly={readOnly} />
|
||||
{formDescription && <FormDescription>{formDescription}</FormDescription>}
|
||||
<FormMessage />
|
||||
</FormItem>
|
||||
)}
|
||||
/>
|
||||
}
|
||||
Reference in New Issue
Block a user