bootjack 0.6.8

  • README.md
  • Installing
  • Versions
  • 86

Bootjack

Bootjack is a porting of Twitter Bootstrap 3.0.x in Dart.

Install from Dart Pub Repository

Include the following in your pubspec.yaml:

dependencies:
  bootjack: any

Then run the Pub Package Manager in Dart Editor (Tool > Pub Install). If you are using a different editor, run the command (comes with the Dart SDK):

pub install

Usage

First of all in your HTML file, you need to include the CSS resource:

<head>
	...
	<link rel="stylesheet" href="packages/bootjack/css/bootstrap.min.css">
</head>

Most of the functions in Bootjack components are automatic -- you only need to give the right CSS class on DOM elements and call a global function to register.

For example, a Dropdown button component is prepared by giving the following HTML snippet:

<button class="btn btn-default dropdown-toggle" data-toggle="dropdown">
	Button
	<span class="caret"></span>
</button>
<ul class="dropdown-menu">
	<li><a href="#">Menu Item #1</a></li>
	<li><a href="#">Menu Item #2</a></li>
	<li><a href="#">Menu Item #3</a></li>
</ul>

With the following global registration in Dart:

void main() {
	Dropdown.use();
}

That's right. All you need to do in Dart is to tell Bootjack you are using Dropdown components. You can also progammatically access and manipulate the Dropdown:

Dropdown dd = Dropdown.wire(element);
dd.toggle();

Check more examples and the API reference for more features. Also, you can read the reference of Bootstrap.

Notes to Contributors

Test and Debug

You are welcome to submit bugs and feature requests. Or even better if you can fix or implement them!

Fork Bootjack

If you'd like to contribute back to the core, you can fork this repository and send us a pull request, when it is ready.

Please be aware that one of Rikulo's design goals is to keep the sphere of API as neat and consistency as possible. Strong enhancement always demands greater consensus.

If you are new to Git or GitHub, please read this guide first.

Who Uses

  • Quire - a simple, collaborative, multi-level task management tool.

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  bootjack: "^0.6.8"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:bootjack/bootjack.dart';
        
Version Uploaded Documentation Archive
0.6.8 Jul 6, 2017 Go to the documentation of bootjack 0.6.8 Download bootjack 0.6.8 archive
0.6.7+2 Apr 12, 2017 Go to the documentation of bootjack 0.6.7+2 Download bootjack 0.6.7+2 archive
0.6.7+1 Mar 16, 2017 Go to the documentation of bootjack 0.6.7+1 Download bootjack 0.6.7+1 archive
0.6.7 Mar 16, 2017 Go to the documentation of bootjack 0.6.7 Download bootjack 0.6.7 archive
0.6.6 Aug 8, 2016 Go to the documentation of bootjack 0.6.6 Download bootjack 0.6.6 archive
0.6.5+5 Apr 27, 2016 Go to the documentation of bootjack 0.6.5+5 Download bootjack 0.6.5+5 archive
0.6.5+4 Mar 18, 2016 Go to the documentation of bootjack 0.6.5+4 Download bootjack 0.6.5+4 archive
0.6.5+3 Jul 3, 2015 Go to the documentation of bootjack 0.6.5+3 Download bootjack 0.6.5+3 archive
0.6.5+2 Sep 11, 2014 Go to the documentation of bootjack 0.6.5+2 Download bootjack 0.6.5+2 archive
0.6.5+1 Jul 17, 2014 Go to the documentation of bootjack 0.6.5+1 Download bootjack 0.6.5+1 archive

All 31 versions...

Analysis

We analyzed this package on Apr 23, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
82 / 100
Health:
Code health derived from static analysis. [more]
99 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
76 / 100
Overall score:
Weighted score of the above. [more]
86
Learn more about scoring.

Platforms

Detected platforms: web

Primary library: package:bootjack/bootjack.dart with components: html.

Suggestions

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • Use constrained dependencies.

    The pubspec.yaml contains 2 dependencies without version constraints. Specify version ranges for the following dependencies: browser, dquery.

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 17 hints.

    Run dartfmt to format lib/bootjack.dart.

    Run dartfmt to format lib/bootjack_plugin.dart.

    Similar analysis of the following files failed:

    • lib/src/affix.dart (hint)
    • lib/src/alert.dart (hint)
    • lib/src/button.dart (hint)
    • lib/src/carousel.dart (hint)
    • lib/src/collapse.dart (hint)
    • lib/src/dropdown.dart (hint)
    • lib/src/modal.dart (hint)
    • lib/src/popover.dart (hint)
    • lib/src/scrollspy.dart (hint)
    • lib/src/tab.dart (hint)
    • lib/src/tooltip.dart (hint)
    • lib/src/transition.dart (hint)
    • lib/src/util/util.dart (hint)
  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use bootjack.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
browser any 0.10.0+3
dquery >=0.6.0 0.8.6
Transitive dependencies
intl 0.15.6
path 1.5.1