withCustomDecorator()

Home > @gooddata/sdk-ui-dashboard > IDashboardInsightCustomizer > withCustomDecorator

IDashboardInsightCustomizer.withCustomDecorator() method

Register a factory for insight decorator providers.

Signature:

withCustomDecorator(providerFactory: (next: InsightComponentProvider) => OptionalInsightComponentProvider): IDashboardInsightCustomizer;

Parameters

Parameter	Type	Description
providerFactory	(next: InsightComponentProvider) => OptionalInsightComponentProvider	factory

Returns:

IDashboardInsightCustomizer

Remarks

Decorators are a way to add customizations or embellishments on top of an existing component. Decorators are more complex to write because they need to work with the component they should decorate and add 'something' on top of that component.

This is best illustrated on an example:

Example

withCustomDecorator((next) => {
    return (insight, widget) => {
        if (some_condition_to_prevent_decoration) {
            return undefined;
        }

        // Make sure you call this outside the component render function,
        // otherwise a new instance of the decorated component is created on each re-render.
        const Decorated = next(insight, widget);

        function MyCustomDecorator(props) {
             return (
                 <div>
                     <p>My Custom Decoration</p>
                     <Decorated {...props} />
                 </div>
             )
        }

        return MyCustomDecorator;
    }
})

The above shows how to register a decorator that will use some condition to determine whether particular insight is eligible for decoration. If yes, it will add some extra text in front of the insight. Decorator defers rendering of the actual insight to the underlying provider.

Note: the factory function that you specify will be called immediately at the registration time. The provider that it returns will be called at render time.