bootjack 1.0.1

  • README.md
  • Installing
  • Versions
  • 53

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.
  • Keikai - a sophisticated spreadsheet for big data

Use this package as a library

1. Depend on it

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


dependencies:
  bootjack: ^1.0.1

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
1.0.1 May 22, 2019 Go to the documentation of bootjack 1.0.1 Download bootjack 1.0.1 archive
1.0.0+1 Aug 17, 2018 Go to the documentation of bootjack 1.0.0+1 Download bootjack 1.0.0+1 archive
1.0.0 Aug 9, 2018 Go to the documentation of bootjack 1.0.0 Download bootjack 1.0.0 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

All 34 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
62
Health:
Code health derived from static analysis. [more]
38
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
52
Overall:
Weighted score of the above. [more]
53
Learn more about scoring.

We analyzed this package on Jun 25, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.3.2
  • pana: 0.12.18

Platforms

Detected platforms: web

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

Health suggestions

Fix lib/src/tooltip.dart. (-15.25 points)

Analysis of lib/src/tooltip.dart reported 33 hints, including:

line 3 col 1: Prefer using /// for doc comments.

line 13 col 3: Prefer using /// for doc comments.

line 42 col 25: Use = to separate a named parameter from its default value.

line 43 col 24: Use = to separate a named parameter from its default value.

line 76 col 7: DO use curly braces for all flow control structures.

Fix lib/src/modal.dart. (-11.33 points)

Analysis of lib/src/modal.dart reported 24 hints, including:

line 6 col 1: Prefer using /// for doc comments.

line 12 col 3: Prefer using /// for doc comments.

line 17 col 3: Prefer using /// for doc comments.

line 21 col 3: Prefer using /// for doc comments.

line 23 col 42: Use = to separate a named parameter from its default value.

Fix lib/src/dropdown.dart. (-10.89 points)

Analysis of lib/src/dropdown.dart reported 23 hints, including:

line 5 col 1: Prefer using /// for doc comments.

line 12 col 3: Prefer using /// for doc comments.

line 20 col 3: Prefer using /// for doc comments.

line 29 col 3: Prefer using /// for doc comments.

line 36 col 7: DO use curly braces for all flow control structures.

Fix additional 12 files with analysis or formatting issues. (-55.02 points)

Additional issues in the following files:

  • lib/src/collapse.dart (16 hints)
  • lib/src/button.dart (14 hints)
  • lib/src/carousel.dart (14 hints)
  • lib/src/scrollspy.dart (14 hints)
  • lib/src/alert.dart (13 hints)
  • lib/src/tab.dart (12 hints)
  • lib/bootjack_plugin.dart (9 hints)
  • lib/src/affix.dart (7 hints)
  • lib/src/popover.dart (5 hints)
  • lib/bootjack.dart (4 hints)
  • lib/src/transition.dart (4 hints)
  • lib/src/util/util.dart (1 hint)

Maintenance issues and suggestions

Provide a file named CHANGELOG.md. (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.

Use constrained dependencies. (-20 points)

The pubspec.yaml contains 1 dependency without version constraints. Specify version ranges for the following dependencies: dquery.

Documentation URL is insecure. (-5 points)

Update the documentation field and use a secure (https) URL.

The package description is too short. (-3 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and bootjack.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
dquery any 1.0.0+1
Transitive dependencies
intl 0.15.8
path 1.6.2