feat: allow filterProps to be a function

[bschlenk]

filterProps can now be passed as either an array of strings, or a function that will be called with the props value and key and return false to filter out that prop.

Closes #286

[armandabric]

Thanks for rebasing this PR 👍 I will have a look into it in the next days

[armandabric]

Thanks for this change ! Good idea to use a function here, it's a lot more powerful for the users 😃

Before we can merge we should also edit the Options flow definitions to allow add the functional version of the filterProps option:

react-element-to-jsx-string/src/options.js

Line 6 in e4ef85c

filterProps: string[],

[leonelgalan]

Let's get this merged! I was looking for a way to filter props with value of undefined, having a function allows for this and more.

[armandabric]

Let's do this! 🚀

[armandabric]

Released in v14.3.0

[elliotgeno]

I see this is still relatively fresh!!
I would like to make one improvement... Instead of optionally showing the prop with a function, I would like to override the string for the prop's value with that the filterProps function.
For example, if you provide a prop with a reference to another Component, it will try to render that as an object.
Example:
<Accordion.Toggle as={Card.Header} >
returns this string:
<Accordion.Toggle as={{ $$typeof: Symbol(react.forward_ref), defaultProps: undefined, displayName: 'Card.Header', render: function noRefCheck() {} }} >

Ideally, I could write a function that replaces that prop value with the component's displayName. Similar to how options.displayName works... but for property values.

In the above example, I would like to pass the following to filterProps:
filterProps: (value, key) => { if (key === "style") { return false } if (key === "as") { return value.displayName; } }