Export LottieProps

[kb-ig]

How would you feel about exporting the LottieProps type?

I think it would be handy in scenarios where we may want to offload some logic that determine what props to pass in to the player so that it's outside of the main component that renders the player. As an over-simplified example:

const getLottieProps = (componentProps: MyProps): LottieProps => {
  // Some logic that determines the props
  const play = true;
  const goTo = 123;
  return { play, goTo };
}

const MyComponent = (props: MyProps) => {
  return (
    <div className='my-animation'>
      <AnimationHeader/>
        <Lottie {...getLottieProps(props)}/>
      <AnimationFooter/>
    </div>
    );
}

[mifi]

Hi. I think this can be solved in the containing component by using state for these props and then calling setState when the props value is known?

[kb-ig]

Yeah, that's one option. Although sometimes its desirable to have a pure stateless component.

There's definitely a few options to get around the example I gave, but I feel it would be beneficial to allow consumers of this library to access the LottieProps type. I dont really see any reason to keep it private.

Another use case would be extending the type. Perhaps my component is a simple wrapper around the lottie player component and I need a few extra properties, eg.

  type MyProps = LottieProps & {
    myHeaderText: string;
    myFooterText: string
  };

  const MyComponent = (props: MyProps) => {
    return (
      <div className='my-animation'>
        <AnimationHeader text={props.myHeaderText}/>
          <Lottie {...props}/>
        <AnimationFooter text={props.myFooterText}/>
      </div>
    );
  }

[mifi]

Oops sorry, I think I misread. You're only talking about a typescript change here, right? TBH I'm not so proficient in TS, but if it's just a change to index.d.ts that doesn't break anything, then I'm open for a PR!

[mifi]

i think your issue might be a duplicate of #46 ?

[kb-ig]

Yeah, just a little TS change - should be fairly unobtrusive.

My ticket is indeed a dup, sorry about that. I'll close this one off and I'll have a look at opening a PR for that change this week.