Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make element filtering configurable #40

Merged
merged 1 commit into from
Jan 23, 2024
Merged

Make element filtering configurable #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
// Last submitted HTMLFormElement that will cause a browser navigation.
let submittedForm: HTMLFormElement | null = null

function shouldResumeField(field: HTMLInputElement | HTMLTextAreaElement): boolean {
return !!field.id && field.value !== field.defaultValue && field.form !== submittedForm
function shouldResumeField(field: HTMLInputElement | HTMLTextAreaElement, filter: StorageFilter): boolean {
return !!field.id && filter(field) && field.form !== submittedForm
}

function valueIsUnchanged(field: HTMLInputElement | HTMLTextAreaElement): boolean {
return field.value !== field.defaultValue
}

type StorageFilter = (field: HTMLInputElement | HTMLTextAreaElement) => boolean

type PersistOptions = {
selector?: string
keyPrefix?: string
storage?: Pick<Storage, 'getItem' | 'setItem'>
storageFilter?: StorageFilter
}

// Write all ids and values of the selected fields on the page into sessionStorage.
export function persistResumableFields(id: string, options?: PersistOptions): void {
const selector = options?.selector ?? '.js-session-resumable'
const keyPrefix = options?.keyPrefix ?? 'session-resume:'
const storageFilter = options?.storageFilter ?? valueIsUnchanged

let storage
try {
Expand All @@ -33,7 +41,7 @@ export function persistResumableFields(id: string, options?: PersistOptions): vo
}
}

let fields = resumables.filter(field => shouldResumeField(field)).map(field => [field.id, field.value])
let fields = resumables.filter(field => shouldResumeField(field, storageFilter)).map(field => [field.id, field.value])

if (fields.length) {
try {
Expand Down
Loading