@coffeekraken/s-feature

{{#> layout-readme }}

SFeature

This package expose a simple SFeature class that has to be used as base class for your features like SActivateFeature, SFloatingFeature, etc...

Features

• Support for default props
• Support SInterface props definition
• @coffeekraken/s-component-utils availablwe out ob the box
• Support defered mount using the @coffeekraken/s-conductor package
• Support responsive props
• And more...

Usage

Here's how to import and make use of this base feature class:

import __SFeature from '@coffeekraken/s-feature';
export default class MyCoolFeature extends __SFeature {
    constructor(name: string, node: HTMLElement, settings?: any) {
        super(name, node, {
            ...(settings ?? {}),
        });
    }
    mount() {
        // start your feature integration here...
    }
}
export function define(
    props: Partial<ISMyCoolFeatureProps> = {},
    name = 'my-cool-feature',
) {
    __SFeature.defineFeature(name, MyCoolFeature, props);
}

import { define } from './MyCoolFeature';
define({
    // some default props...
});

<div my-cool-feature>
    Hello world
</div>

Properties

{{> interface namespace='@coffeekraken.s-component-utils.js.interface.SComponentUtilsDefaultPropsInterface' }}

API

For more information about the API, please check out the API documentation

{{/ layout-readme }}