Ak-component-base NPM

ComponentBase

ak-component-base is just a simple base component to build other components on top of. The only feature it provides is an override prop which can be used by a consumer to prevent a component from managing it's own state.

An example of this might be a popup component that has an open prop that can be set. If you were tracking this state somewhere (in a Redux store for example) but the component was able to modify it's own open state (i.e responding to a mouseclick) your state could become out of sync and cause issues. By setting the open prop via override instead a component will be prevented from ever modifying that prop.

Note: This means you'll usually need to hook into emitted events to update the state as required.

Try it out

Interact with a live demo of the ak-component-base component.

Installation

npm install ak-component-base

Using the component

This component is meant as a base for other components to extend. To build the base component, you will need to inject the Component and prop dependencies like so:

import { Component, prop } from 'skatejs';
import base from 'ak-component-base';

const Base = base({ Component, prop });

Now you can extend Base.

Counter Component

This component simply keeps track of two numbers (both exposed as props) and increments them itself.

import { define, vdom, Component, prop } from 'skatejs';
import base from 'ak-component-base';

// we inject our Component and prop dependencies
const Base = base({ Component, prop });

const Counter = define('x-counter', class extends Base {
  static get props () {
    return Object.assign({}, {
      count1: prop.number({ default: 1 }),
      count2: prop.number({ default: 2 })
    }, super.props);
  }
  static attached (elem) {
    setInterval(() => (++elem.count1), 1);
    setInterval(() => (++elem.count2), 1000);
  }
  static updated (elem, prev) {
    return super.updated(elem, prev)
  }
  static render (elem) {
    return [
      <div>Count1: {elem.count1}</div>,
      <div>Count2: {elem.count2}</div>
    ];
  }
});

As you can see, one count will increment every millisecond and the other, every second. The main things to notice here are:

Injecting the Component and prop dependencies
class extends Base
Using Object.assign with super.props so that we don't override the Base component's props
Using super.updated, technically only required if you have an updated callback already, otherwise this will be called for you anyway.

By doing this the Counter component now also has the override prop.

App Component

To show the useage of the override prop, we'll create another component to control part of the state. Our App component will let Counter do whatever it likes with count2 but will override count1 to only update every 500 milliseconds and also count up by two.

import { define, vdom, prop, Component } from 'skatejs';

import Counter from './counter'; // our previous example

const App = define('x-app', class extends Component {
  static get props() {
    return {
      count: prop.number({ default: 10 }),
    };
  }
  static attached(elem) {
    setInterval(() => (elem.count += 2), 500);
  }
  static render(elem) {
    return <Counter override={{ count1: elem.count }} />;
  }
});

You'll notice that App keeps track of the count1 state itself (in its count prop) but instead of passing it into the count1 prop of Counter, it is passed in via override. Had it passed it in via count1 the Counter would have continued to increment it every millisecond.

ComponentBase

Kind: global class

Properties
- ComponentBase.override : Object

new ComponentBase()

A component for adding the override functionality to other components.

ComponentBase.override : Object

Overrides for any props that you wish to not be controlled by the component itself.

For instance, if a component has a state prop that it manages and changes by itself and you wish to own that state, you could track and manage your own copy of that state and pass it in through override. This will prevent the component from ever overriding your value.

Kind: static property of ComponentBase
Default: undefined
HTML Example

<ak-component override={{ state: myInternalState }}></ak-component>

JS Example

component.override = { state: myInternalState };

Support and feedback

We're here to help!

Let us know what you think of our components and docs, your feedback is really important for us.

Community support

Ask a question in our forum.

Check if someone has already asked the same question before.

Create a support ticket

Are you in trouble? Let us know!

7 years ago

8 years ago