Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Keybind and modal refactor (#5007)
Artur Pata117cf4618376
diff --git a/assets/js/dashboard/components/search-input.tsx b/assets/js/dashboard/components/search-input.tsxindex 06872f9755..5c8cbc6551 100644--- a/assets/js/dashboard/components/search-input.tsx+++ b/assets/js/dashboard/components/search-input.tsx@@ -7,10 +7,14 @@ import classNames from 'classnames'export const SearchInput = ({onSearch,- className+ className,+ placeholderFocused = 'Search',+ placeholderUnfocused = 'Press / to search'}: {- className?: stringonSearch: (value: string) => void+ className?: string+ placeholderFocused?: string+ placeholderUnfocused?: string}) => {const searchBoxRef = useRef<HTMLInputElement>(null)const [isFocused, setIsFocused] = useState(false)@@ -23,25 +27,14 @@ export const SearchInput = ({)const debouncedOnSearchInputChange = useDebounce(onSearchInputChange)- const blurSearchBox = useCallback(- (event: KeyboardEvent) => {- if (isFocused) {- searchBoxRef.current?.blur()- event.stopPropagation()- }- },- [isFocused]- )+ const blurSearchBox = useCallback(() => {+ searchBoxRef.current?.blur()+ }, [])- const focusSearchBox = useCallback(- (event: KeyboardEvent) => {- if (!isFocused) {- searchBoxRef.current?.focus()- event.stopPropagation()- }- },- [isFocused]- )+ const focusSearchBox = useCallback((event: KeyboardEvent) => {+ searchBoxRef.current?.focus()+ event.stopPropagation()+ }, [])return (<>@@ -49,20 +42,22 @@ export const SearchInput = ({keyboardKey="Escape"type="keyup"handler={blurSearchBox}- shouldIgnoreWhen={[isModifierPressed]}+ shouldIgnoreWhen={[isModifierPressed, () => !isFocused]}+ target={searchBoxRef.current}/><KeybindkeyboardKey="/"type="keyup"handler={focusSearchBox}- shouldIgnoreWhen={[isModifierPressed]}+ shouldIgnoreWhen={[isModifierPressed, () => isFocused]}+ target={document}/><inputonBlur={() => setIsFocused(false)}onFocus={() => setIsFocused(true)}ref={searchBoxRef}type="text"- placeholder={isFocused ? 'Search' : 'Press / to search'}+ placeholder={isFocused ? placeholderFocused : placeholderUnfocused}className={classNames('shadow-sm dark:bg-gray-900 dark:text-gray-100 focus:ring-indigo-500 focus:border-indigo-500 block sm:text-sm border-gray-300 dark:border-gray-500 rounded-md dark:bg-gray-800 w-48',classNamediff --git a/assets/js/dashboard/datepicker.tsx b/assets/js/dashboard/datepicker.tsxindex ae5fa74a98..913089100f 100644--- a/assets/js/dashboard/datepicker.tsx+++ b/assets/js/dashboard/datepicker.tsx@@ -449,6 +449,7 @@ export default function QueryPeriodPicker() {type="keydown"handler={onClick || closeMenu}shouldIgnoreWhen={[isModifierPressed, isTyping]}+ target={document}/>) : (<NavigateKeybinddiff --git a/assets/js/dashboard/keybinding.tsx b/assets/js/dashboard/keybinding.tsxindex cf3caa138f..f2d6f111b7 100644--- a/assets/js/dashboard/keybinding.tsx+++ b/assets/js/dashboard/keybinding.tsx@@ -60,17 +60,21 @@ type KeyboardEventType = keyof Pick<'keyup' | 'keydown' | 'keypress'>-export function Keybind({- keyboardKey,- type,- handler,- shouldIgnoreWhen = []-}: {+type KeybindOptions = {keyboardKey: stringtype: KeyboardEventTypehandler: (event: KeyboardEvent) => voidshouldIgnoreWhen?: Array<(event: KeyboardEvent) => boolean>-}) {+ target?: Document | HTMLElement | null+}++function useKeybind({+ keyboardKey,+ type,+ handler,+ shouldIgnoreWhen = [],+ target+}: KeybindOptions) {const wrappedHandler = useCallback((event: KeyboardEvent) => {if (isKeyPressed(event, { keyboardKey, shouldIgnoreWhen })) {@@ -78,19 +82,29 @@ export function Keybind({}},[keyboardKey, handler, shouldIgnoreWhen]- )+ ) as EventListeneruseEffect(() => {- const registerKeybind = () =>- document.addEventListener(type, wrappedHandler)+ const registerKeybind = (t: HTMLElement | Document) =>+ t.addEventListener(type, wrappedHandler)- const deregisterKeybind = () =>- document.removeEventListener(type, wrappedHandler)+ const deregisterKeybind = (t: HTMLElement | Document) =>+ t.removeEventListener(type, wrappedHandler)- registerKeybind()+ if (target) {+ registerKeybind(target)+ }++ return () => {+ if (target) {+ deregisterKeybind(target)+ }+ }+ }, [target, type, wrappedHandler])+}- return deregisterKeybind- }, [type, wrappedHandler])+export function Keybind(opts: KeybindOptions) {+ useKeybind(opts)return null}@@ -115,6 +129,7 @@ export function NavigateKeybind({type={type}handler={handler}shouldIgnoreWhen={[isModifierPressed, isTyping]}+ target={document}/>)}diff --git a/assets/js/dashboard/stats/modals/modal.js b/assets/js/dashboard/stats/modals/modal.jsindex 2b7114cb83..020c05517e 100644--- a/assets/js/dashboard/stats/modals/modal.js+++ b/assets/js/dashboard/stats/modals/modal.js@@ -1,6 +1,6 @@import React from "react";import { createPortal } from "react-dom";-import { NavigateKeybind } from '../../keybinding'+import { isModifierPressed, isTyping, Keybind } from "../../keybinding"import { rootRoute } from "../../router";import { useAppNavigate } from "../../navigation/use-app-navigate";@@ -41,20 +41,13 @@ class Modal extends React.Component {return;}- this.close()+ this.props.onClose()}handleResize() {this.setState({ viewport: window.innerWidth });}- close() {- this.props.navigate({- path: rootRoute.path,- search: (search) => search,- })- }-/*** @description* Decide whether to set max-width, and if so, to what.@@ -77,7 +70,7 @@ class Modal extends React.Component {render() {return createPortal(<>- <NavigateKeybind keyboardKey="Escape" type="keyup" navigateProps={{ path: rootRoute.path, search: (search) => search }} />+ <Keybind keyboardKey="Escape" type="keyup" handler={this.props.onClose} target={document} shouldIgnoreWhen={[isModifierPressed, isTyping]} /><div className="modal is-open" onClick={this.props.onClick}><div className="modal__overlay"><button className="modal__close"></button>@@ -99,5 +92,6 @@ class Modal extends React.Component {export default function ModalWithRouting(props) {const navigate = useAppNavigate()- return <Modal {...props} navigate={navigate} />+ const onClose = props.onClose ?? (() => navigate({ path: rootRoute.path, search: (s) => s }))+ return <Modal {...props} onClose={onClose} />}diff --git a/lib/plausible/segments/segment.ex b/lib/plausible/segments/segment.exindex 26846bfb46..d2edfe2d7a 100644--- a/lib/plausible/segments/segment.ex+++ b/lib/plausible/segments/segment.ex@@ -155,8 +155,8 @@ defmodule Plausible.Segments.Segment do)@doc """- This function handles the error from building the naive query that is used to validate segment filters,- collecting filter related errors into a list.+ This function handles the error from building the naive query that is used to validate segment filters.+ If the error is only about filters, it's marked as :invalid_filters error and ultimately forwarded to client.If the error is not only about filters, the client can't do anything about the situation,and the error message is returned as-is.