Documentation

[UltraCakeBakery]

HEADLINE

• docs: headline test status badge #50
• docs: headline NPM version badge #51
• docs: headline GITHUB stars badge (for npm readme) #52

prerequisite

• docs(prerequisite): Explain properly that if you do not understand how SvelteKit works and expects you to handle form validation yourself, you should not yet try and use this library. #53

INTRODUCTION

• docs(introduction): Explain why you want to use this library #54
• docs(introduction): Explain what the library is not #55

NATIVE VALIDATION FIRST

• docs(native-validation-first): Explain how our default form components are made to work exceptionally well when javascript is disabled and/or the form component has not yet been hydrated nor enhanced. #56
• docs(native-validation-first): Refer to caveats section #57

INSTALLATION

• docs(installation): show install commands #58
• docs(installation): show creation of a ~forms.ts config file using create() #59
• docs(installation): show mounting of a generated form component #60
• docs(installation): show handling form actions #61

VALIDATIONS

• docs(validations): Explain how all validations are done on both the client side, and serverside when the createActions helper is used. #62
• docs(validations): Refer to form fields section for list of field validations #63

CUSTOM VALIDATIONS

• docs(custom-validations):Refer to form fields section for list of field validations #64

FORMS

• docs(forms): List all options like METHOD, NAME, ID etc. #65
• docs(forms): List all available slots #66
• docs(forms): Explain how to add fields #67
• docs(forms): Explain how to add buttons #68

FORM FIELDS

• docs(forms): Explain how you can overwrite the labels of inputs (text and component) #70
• docs(forms): Explain how you can overwrite the descriptions of inputs (text and component) #71
• docs(form-fields): Explain how you can overwrite the descriptions of inputs (text and component) #72

FIELD VALIDATIONS

• docs(field-validations): Show a list of all available validations, and their supported input types (using except for format) #69

CUSTOM FIELD VALIDATIONS

• docs(custom-field-validations): Explain the t.b.d custom validations API #73

FORM BUTTONS

• docs(form-buttons): Explain how you can overwrite the labels, value, etc. #78
• docs(form-buttons): Explain there is always one button added by default called submit form #79

SNAPSHOTS

• docs(form-snapshots): Explain how snapshots work #74

ACTIONS

• docs(form-actions): Explain createActions #75

SERVERSIDE VALIDATION

• docs(serverside-validation): Explain throw fieldError() #76
• docs(serverside-validation): Explain returning from createActions wrapped action #77

KNOWN LIMITATIONS AND CAVEATS

HELP / FAQ