npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mobx-vm-entities

v3.0.0

Published

## Usage (with using `rootStore`)

Downloads

392

Readme

mobx-vm-entities

Usage (with using rootStore)

1. Create ViewModelImpl class

This class you will needed for creating your own view model classes
You can implement your own solution based on ViewModel<Payload, ParentViewModel>, but AbstractViewModel has a lot of ready solutions like mount(), or payloadChanged()
Only one thing that you should implement is the getParentViewModel and constructor because it requires (in most cases) RootStore

import {
  AbstractViewModel,
  AbstractViewModelParams,
  ViewModel,
} from 'mobx-vm-entities';

export class ViewModelImpl<
    Payload extends AnyObject = EmptyObject,
    ParentViewModel extends ViewModel<any> = ViewModel<any>,
  >
  extends AbstractViewModel<Payload, ParentViewModel>
  implements ViewModel<Payload, ParentViewModel>
{
  constructor(
    protected rootStore: RootStore,
    params: AbstractViewModelParams<Payload>,
  ) {
    super(params);
  }

  protected getParentViewModel(
    parentViewModelId: Maybe<string>,
  ): ParentViewModel | null {
    return this.rootStore.viewModels.get<ParentViewModel>(parentViewModelId);
  }
}

2. Create ViewModelStoreImpl Class

This class will contains info about all your view model instances and will have fabric for creating instances of the your ViewModelImpl classes.
Because it requires (in most cases) the rootStore

import {
  AbstractViewModelParams,
  AbstractViewModelStore,
  ViewModel,
  ViewModelCreateConfig,
  ViewModelStore,
} from 'mobx-vm-entities';

export class ViewModelStoreImpl
  extends AbstractViewModelStore
  implements ViewModelStore
{
  constructor(protected rootStore: RootStore) {
    super();
  }

  create<VM extends ViewModel<any, ViewModel<any, any>>>(
    config: ViewModelCreateConfig<VM>,
  ): VM {
    const VM = config.VM;

    const params: AbstractViewModelParams<VM['payload']> = {
      id: config.id,
      payload: config.payload,
      parentViewModelId: config.parentViewModelId,
    };

    return new VM(this.rootStore, params);
  }
}

3. Attach your ViewModelStore to rootStore

rootStore.viewModels = new ViewModelStoreImpl(rootStore);

4. Add ViewModelsProvider at the root of your React app

import { ViewModelsProvider } from 'mobx-vm-entities';
import { observer } from 'mobx-react-lite';

import { useRootStore } from '../../root-store'; // code line maybe different for your case

export const App = observer(() => {
  const rootStore = useRootStore();


  return (
    <ViewModelsProvider value={rootStore.viewModels}>
      <Router />
      <Notifications />
      <ModalsContainer />
    </ViewModelsProvider>
  )
})

5. Use it

import { ViewModelImpl } from "your-import";

type Payload = {
  test: number
}

class MyButtonViewModel extends ViewModelImpl<Payload> {
  title = 'click me!';

  mount() {
    super.mount();

    this.disposer.add(
      reaction(() => this.payload.test > 10, (ok) => {
        console.info("ok", ok)
      })
    )
  }

  unmount() {
    super.unmount();
  }

  payloadChanged(payload) {
    console.info('payload', payload);
  }

  handleClick = () => {
    console.info("click")
  }

  dispose() {
    super.dispose();

    // your dispose
  }
}

const MyButtonView = observer(({ model }: ViewModelProps<MyButtonViewModel>) => {


  return (
    <button onClick={model.handleClick}>{model.title}</button>
  )
})


export const MyButton = withViewModel(
  MyButtonViewModel,
  // additional config
  // {
  //   id?: string, // could be used to set fixed identifier for singleton view models  
  //   fallback?: ComponentType, // render fallback component  
  //   ctx?: Record<string, any>, // additional object to customize something using viewModels store  
  //   factory?:  (config: ViewModelCreateConfig<VM>) => VM; // function which create the instance of this view model  
  // }
)(MyButtonView);


export const SomeOtherComponent = () => {
  return (
    <div>
      <MyButton payload={{ test: 10 }} />
    </div>
  )
}