Skip to content

rodkisten/roderuda

 
 

Repository files navigation

RodEruda

Console for Mobile Browsers — a fork and rebrand of Eruda

License

Install

npm install roderuda --save-dev

Add this script to your page:

<script src="node_modules/roderuda/roderuda.js"></script>
<script>RodEruda.init();</script>

Or use the CDN from GitHub Pages:

<script src="https://oirodolfo.github.io/eruda-console-browser/roderuda/roderuda.js"></script>
<script>RodEruda.init();</script>

Minified version:

<script src="https://oirodolfo.github.io/eruda-console-browser/roderuda/roderuda.min.js"></script>
<script>RodEruda.init();</script>

Browser Global

When loaded via a <script> tag, RodEruda is exposed as window.RodEruda.

<script src="roderuda.js"></script>
<script>
  RodEruda.init();
  RodEruda.show();
</script>

Build

This project uses tsdown for bundling.

Output file Description
dist/roderuda.js Non-minified, sourcemap included
dist/roderuda.min.js Minified, sourcemap included
dist/roderuda.with-comments.js Non-minified, comments preserved, no sourcemap
# Full build (all three outputs)
npm run build

# Minified only
npm run build:min

# Dev build (development mode)
npm run build:dev

# Type check
npm run typecheck

# Tests
npm run test

# Clean dist/
npm run clean

GitHub Pages

Built assets are published to GitHub Pages under the /roderuda path:

API

RodEruda exposes the same API as the original Eruda:

// Initialize
RodEruda.init();

// Initialize with options
RodEruda.init({
  container: document.getElementById('my-container'),
  tool: ['console', 'elements'],
  useShadowDom: true,
  inline: false,
  defaults: {
    theme: 'Dark',
    displaySize: 50,
  },
});

// Show / hide
RodEruda.show();
RodEruda.hide();

// Destroy
RodEruda.destroy();

// Get a tool panel
const consolePanel = RodEruda.get('console');

Related Projects

  • eruda: Original project this was forked from.
  • chobitsu: Chrome devtools protocol JavaScript implementation.
  • licia: Utility library.
  • luna: UI components.

License

MIT

About

Console for mobile browsers

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 84.2%
  • SCSS 9.7%
  • HTML 4.0%
  • CSS 2.1%