Skip to content

feat(mobx-react-lite): add support passing propsAreEqual fn for obser… #4680

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

Open
js2me wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(mobx-react-lite): add support passing propsAreEqual fn for obser… #4680

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .changeset/quiet-stars-sing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"mobx-react-lite": patch
---

support passing `propsAreEqual` for `observer()` HOC
13 changes: 7 additions & 6 deletions packages/mobx-react-lite/src/observer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,18 @@ const ReactMemoSymbol = hasSymbol
* @deprecated Observer options will be removed in the next major version of mobx-react-lite.
* Look at the individual properties for alternatives.
*/
export interface IObserverOptions {
export interface IObserverOptions<P extends object = object> {
/**
* @deprecated Pass a `React.forwardRef` component to observer instead of using the options object
* e.g. `observer(React.forwardRef(fn))`
*/
readonly forwardRef?: boolean
propsAreEqual?: (prevProps: Readonly<P>, nextProps: Readonly<P>) => boolean
Comment on lines 31 to +32
}

export function observer<P extends object, TRef = {}>(
baseComponent: React.ForwardRefRenderFunction<TRef, P>,
options: IObserverOptions & {
options: IObserverOptions<P> & {
/**
* @deprecated Pass a `React.forwardRef` component to observer instead of using the options object
* e.g. `observer(React.forwardRef(fn))`
Expand All @@ -46,7 +47,7 @@ export function observer<P extends object, TRef = {}>(

export function observer<P extends object>(
baseComponent: React.FunctionComponent<P>,
options?: IObserverOptions
options?: IObserverOptions<P>
): React.FunctionComponent<P>

export function observer<P extends object, TRef = {}>(
Expand All @@ -58,7 +59,7 @@ export function observer<P extends object, TRef = {}>(
>
export function observer<
C extends React.FunctionComponent<any> | React.ForwardRefRenderFunction<any>,
Options extends IObserverOptions
Options extends IObserverOptions<React.ComponentProps<C>>
>(
Comment on lines 60 to 63
baseComponent: C,
options?: Options
Expand All @@ -80,7 +81,7 @@ export function observer<P extends object, TRef = {}>(
| React.FunctionComponent<P>
| React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<TRef>>,
// TODO remove in next major
options?: IObserverOptions
options?: IObserverOptions<P>
) {
if (process.env.NODE_ENV !== "production" && warnObserverOptionsDeprecated && options) {
warnObserverOptionsDeprecated = false
Expand Down Expand Up @@ -156,7 +157,7 @@ export function observer<P extends object, TRef = {}>(
// memo; we are not interested in deep updates
// in props; we assume that if deep objects are changed,
// this is in observables, which would have been tracked anyway
observerComponent = memo(observerComponent)
observerComponent = memo(observerComponent, options?.propsAreEqual)

copyStaticProperties(baseComponent, observerComponent)

Expand Down