minitel-react v6.2.0

Minitel React

A (somewhat experimental! also somewhat opiniated) package to render react into a minitel!

Experimental until v4.2.0, thanks for understanding!

Principle

This package interacts with a stream which is supposed to be relayed to the Minitel. The duplex stream could come from, for instance, a serial handler.

Example

import { SerialPort } from 'serialport';
import { render, Minitel } from 'minitel-react';

const serialport = new SerialPort({ path: '/dev/ttyUSB0', baudRate: 1200, parity: 'even' });

function App() {
    return (
        <yjoin widthAlign="middle" heightAlign="middle">
            <para invert>
                Hello world!
            </para>
        </yjoin>
    );
}

render(<App/>, new Minitel(serialport));

Also: an example with websockets, miedit minitel (You may need to clone miedit into miedit/ first), inside the dist/examples folder

Reference

CharAttributes

On colors

MinitelObjectAttributes

new Minitel

On Settings

<yjoin>

Will vertically join all children |Attribute |Type |Description | |---------------------|----------------------|-----------------------------------------------------------------| |gap |number or string |The amount of gap to be had. Can be a number or space-{between,around,evenly} (refer to flexbox's justify-center)| |widthAlign |string |The way to align along the x axis (start, middle, end or stretch)| |heightAlign |string |The way to align along the y axis (start, middle or end) |

<xjoin>

Will horizontally join all children |Attribute |Type |Description | |---------------------|----------------------|-----------------------------------------------------------------| |gap |number or string |The amount of gap to be had. Can be a number or space-{between,around,evenly} (refer to flex's justify-center)| |heightAlign |string |The way to align along the y axis (start, middle, end or stretch)| |widthAlign |string |The way to align along the x axis (start, middle or end) |

<input>

Will be an input |Attribute |Type |Description | |---------------------|----------------------|-----------------------------------------------------------------| |autofocus |boolean |Whether or not to autofocus on the input | |type |string |The type of input (for now, text or password) | |multiline |boolean |Whether or not the input should be multiline | |onChange |function(value) |A function to be called whenever the input is changed | |onScroll |function([dy, dx]) |A function to be called whenever the input is scolled |

<para>

Will show text

<scroll>

Will allow scrolling (the element needs to be focused to be scrolled upon)

Attributes

noscrollbar will hide the scrollbar auto will hide the scrollbar except when the scrollable area exists (I.E. content does not fit) scroll and pad only differ in the case that the children already fit in the imposed area: scroll will show the scrollbar anyway, while pad will leave this space empty

<cont>

Will hold one child.

Attributes

<zjoin>

Will allow stacking of one element onto another. The character \x09 will order zjoin to show the character underneath.

Attributes