API.md

Api

init

Initialize eruda.

Options

Name	Type	Desc
container	element	Container element. If not set, it will append an element directly under html root element
tool	string array	Choose which default tools you want, by default all will be added
autoScale=true	boolean	Auto scale eruda for different viewport settings
useShadowDom=true	boolean	Use shadow dom for css encapsulation
defaults	object	Default settings

Available default settings:

Name	Type	Desc
transparency	number	Transparency, 0 to 1
displaySize	number	Display size, 0 to 100
theme	string	Theme, defaults to Light or Dark in dark mode

const el = document.createElement('div');
document.body.appendChild(el);

eruda.init({
    container: el,
    tool: ['console', 'elements'],
    useShadowDom: true,
    autoScale: true,
    defaults: {
        displaySize: 50,
        transparency: 0.9,
        theme: 'Monokai Pro'
    }
});

destroy

Destory eruda.

Note: You can call init method again after destruction.

eruda.destroy();

scale

Set or get scale.

eruda.scale(); // -> 1
eruda.scale(1.5);

position

Set or get entry button position.

It will not take effect if given pos is out of range.

eruda.position({x: 20, y: 20});
eruda.position(); // -> {x: 20, y: 20}

get

Get tool, eg. console, elements panels.

let console = eruda.get('console');
console.log('eruda');

add

Add tool.

eruda.add(new (eruda.Tool.extend({
    name: 'test'
})));

remove

Remove tool.

eruda.remove('console');

show

Show eruda panel.

eruda.show();
eruda.show('console');

hide

Hide eruda panel.

eruda.hide();