HUBComponentShowcaseManager

@protocol HUBComponentShowcaseManager <NSObject>

Protocol defining the public API of a Hub Framework component showcase manager

You interact with this API to build showcase functionality for available components in this instance of the Hub Framework. Normally, you don’t call it from production code (although there is no harm in doing so), but rather use it to build tooling on top of the framework.

The Hub Framework does not provide any built-in functionality for showcases, besides providing the component identifiers that have been declared as showcasable, and the ability to create snapshot images of a component instance, for showcase purposes.

You don’t conform to this protocol yourself, instead the application’s HUBManager comes setup with a showcase manager that you can use.

  • The component identifiers that have been declared as showcaseable

    It’s up to each component factory that has been registered with HUBComponentRegistry to (optionally) declare an array of showcaseable component names (by conforming to HUBComponentFactoryShowcaseNameProvider), which will then be used to construct the component identifiers returned from this property.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic)
    NSArray<HUBIdentifier *> *_Nonnull showcaseableComponentIdentifiers;

  • Return a human readable name for a component that can be displayed in a showcase

    Declaration

    Objective-C

    - (nullable NSString *)showcaseNameForComponentIdentifier:
    (nonnull HUBIdentifier *)componentIdentifier;

    Parameters

    componentIdentifier

    The identifier of the component to return a showcase name for

    Return Value

    A component name that can be displayed in a showcase UI, or nil if the identifier wasn’t recognized by any component factory.

  • Create a new component model builder that is also able to generate showcase snapshots

    You can mutate the returned builder to reflect what kind of component & content you wish to generate a snapshot with, then ask the builder to generate a snapshot. Snapshots can be used when implementing showcases for components or in tooling associated with the Hub Framework.

    Declaration

    Objective-C

    - (nonnull id<HUBComponentModelBuilder, HUBComponentShowcaseSnapshotGenerator>)
    createShowcaseSnapshotComponentModelBuilder;