BsScrollspy class

A widget that implements the Bootstrap Scrollspy behavior.

It listens to the scrolling events of its child via the provided controller and calculates which registered target is currently visible in the viewport.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• BsScrollspy

Available extensions

• BsAlignmentExtension
• BsBorderExtension
• BsDisplayExtension
• BsSizeExtension
• BsSpacingExtension
• BsVerticalAlignExtension

Constructors

BsScrollspy({Key? key, required BsScrollspyController controller, required Widget child, double activationMargin = 50.0})

Creates a Bootstrap Scrollspy component.

const

Properties

activationMargin → double

The vertical margin (in logical pixels) from the top of the container where a target is considered "active". Defaults to 50.0. This acts similarly to the rootMargin in Bootstrap.

final

child → Widget

The scrollable child, typically a SingleChildScrollView or ListView.

final

controller → BsScrollspyController

The controller that manages the active target and scrolling.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

align(AlignmentGeometry alignment) → Widget

Available on Widget, provided by the BsAlignmentExtension extension

Aligns the widget within its parent using the given alignment.

alignBaseline({TextBaseline baseline = TextBaseline.alphabetic}) → WidgetSpan

Available on Widget, provided by the BsVerticalAlignExtension extension

Aligns the baseline of the element with the baseline of its parent.

alignBottom() → Widget

Available on Widget, provided by the BsAlignmentExtension extension

Aligns the widget to the bottom center of its parent.

alignBottomInline() → WidgetSpan

Available on Widget, provided by the BsVerticalAlignExtension extension

Aligns the bottom of the element with the bottom of the lowest element on the line.

alignEnd() → Widget

Available on Widget, provided by the BsAlignmentExtension extension

Aligns the widget to the end (right) of its parent.

alignMiddle() → WidgetSpan

Available on Widget, provided by the BsVerticalAlignExtension extension

Centers the element vertically within the line.

alignStart() → Widget

Available on Widget, provided by the BsAlignmentExtension extension

Aligns the widget to the start (left) of its parent.

alignTextBottom({TextBaseline baseline = TextBaseline.alphabetic}) → WidgetSpan

Available on Widget, provided by the BsVerticalAlignExtension extension

Aligns the bottom of the element with the bottom of the parent element's font.

alignTextTop({TextBaseline baseline = TextBaseline.alphabetic}) → WidgetSpan

Available on Widget, provided by the BsVerticalAlignExtension extension

Aligns the top of the element with the top of the parent element's font.

alignTop() → Widget

Available on Widget, provided by the BsAlignmentExtension extension

Aligns the widget to the top center of its parent.

alignTopInline() → WidgetSpan

Available on Widget, provided by the BsVerticalAlignExtension extension

Aligns the top of the element with the top of the tallest element on the line.

border({Color? color, double width = 1.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Adds a default border on all sides, matching .border.

border0() → Widget

Available on Widget, provided by the BsBorderExtension extension

Removes all borders, matching .border-0.

borderBottom({Color? color, double width = 1.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Adds a border to the bottom side, matching .border-bottom.

borderEnd({Color? color, double width = 1.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Adds a border to the end (right) side, matching .border-end.

borderStart({Color? color, double width = 1.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Adds a border to the start (left) side, matching .border-start.

borderTop({Color? color, double width = 1.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Adds a border to the top side, matching .border-top.

borderVariant(BuildContext context, BsVariant variant, {double width = 1.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Colors the border based on the theme color variant, matching .border-*.

center() → Widget

Available on Widget, provided by the BsAlignmentExtension extension

Centers the widget within its parent.

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<BsScrollspy>

Creates the mutable state for this widget at a given location in the tree.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

dNone() → Widget

Available on Widget, provided by the BsDisplayExtension extension

Convenient alias for gone(true). Maps to Bootstrap's .d-none.

expanded([int flex = 1]) → Widget

Available on Widget, provided by the BsSizeExtension extension

Wraps the widget in an Expanded widget.

gone(bool gone) → Widget

Available on Widget, provided by the BsDisplayExtension extension

Hides the widget and removes it from the layout if gone is true.

h(double height) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets a fixed height for the widget.

h100() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the height to 100% (double.infinity).

h25() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the height to 25% of parent (FractionallySizedBox).

h50() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the height to 50% of parent (FractionallySizedBox).

h75() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the height to 75% of parent (FractionallySizedBox).

m(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform margin on all sides.

m0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero margin on all sides.

m1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform margin of BsSpacing.s1 on all sides.

m2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform margin of BsSpacing.s2 on all sides.

m3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform margin of BsSpacing.s3 on all sides.

m4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform margin of BsSpacing.s4 on all sides.

m5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform margin of BsSpacing.s5 on all sides.

mAuto() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Centers the widget horizontally and vertically, matching m-auto.

mb(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies margin only to the bottom side.

mb0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero margin to the bottom side.

mb1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom margin of BsSpacing.s1.

mb2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom margin of BsSpacing.s2.

mb3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom margin of BsSpacing.s3.

mb4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom margin of BsSpacing.s4.

mb5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom margin of BsSpacing.s5.

mbAuto() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Aligns the widget to the top of its parent, matching mb-auto in vertical layout.

me(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies margin only to the end (right) side.

me0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero margin to the end side.

me1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) margin of BsSpacing.s1.

me2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) margin of BsSpacing.s2.

me3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) margin of BsSpacing.s3.

me4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) margin of BsSpacing.s4.

me5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) margin of BsSpacing.s5.

meAuto() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Aligns the widget to the start (left) of its parent, matching me-auto in horizontal layout.

minH100() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets min-height to 100% of parent.

minVh100(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets min-height to 100vh (100% of viewport height).

minVh50(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets min-height to 50vh (50% of viewport height).

minVw100(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets min-width to 100vw (100% of viewport width).

minVw50(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets min-width to 50vw (50% of viewport width).

minW100() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets min-width to 100% of parent.

ms(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies margin only to the start (left) side.

ms0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero margin to the start side.

ms1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) margin of BsSpacing.s1.

ms2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) margin of BsSpacing.s2.

ms3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) margin of BsSpacing.s3.

ms4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) margin of BsSpacing.s4.

ms5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) margin of BsSpacing.s5.

msAuto() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Aligns the widget to the end (right) of its parent, matching ms-auto in horizontal layout.

mt(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies margin only to the top side.

mt0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero margin to the top side.

mt1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top margin of BsSpacing.s1.

mt2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top margin of BsSpacing.s2.

mt3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top margin of BsSpacing.s3.

mt4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top margin of BsSpacing.s4.

mt5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top margin of BsSpacing.s5.

mtAuto() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Aligns the widget to the bottom of its parent, matching mt-auto in vertical layout.

mx(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal margin (left and right).

mx0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero horizontal margin (left and right).

mx1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal margin (left and right) of BsSpacing.s1.

mx2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal margin (left and right) of BsSpacing.s2.

mx3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal margin (left and right) of BsSpacing.s3.

mx4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal margin (left and right) of BsSpacing.s4.

mx5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal margin (left and right) of BsSpacing.s5.

mxAuto() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Centers the widget horizontally within its parent, matching mx-auto.

my(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical margin (top and bottom).

my0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero vertical margin (top and bottom).

my1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical margin (top and bottom) of BsSpacing.s1.

my2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical margin (top and bottom) of BsSpacing.s2.

my3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical margin (top and bottom) of BsSpacing.s3.

my4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical margin (top and bottom) of BsSpacing.s4.

my5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical margin (top and bottom) of BsSpacing.s5.

myAuto() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Centers the widget vertically within its parent, matching my-auto.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

opacity(double value) → Widget

Available on Widget, provided by the BsDisplayExtension extension

Sets the opacity of the widget.

p(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform padding on all sides.

p0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero padding on all sides.

p1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform padding of BsSpacing.s1 on all sides.

p2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform padding of BsSpacing.s2 on all sides.

p3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform padding of BsSpacing.s3 on all sides.

p4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform padding of BsSpacing.s4 on all sides.

p5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies uniform padding of BsSpacing.s5 on all sides.

padding(EdgeInsets value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies custom EdgeInsets as padding.

pb(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies padding only to the bottom side.

pb0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero padding to the bottom side.

pb1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom padding of BsSpacing.s1.

pb2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom padding of BsSpacing.s2.

pb3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom padding of BsSpacing.s3.

pb4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom padding of BsSpacing.s4.

pb5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies bottom padding of BsSpacing.s5.

pe(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies padding only to the end (right) side.

pe0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero padding to the end side.

pe1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) padding of BsSpacing.s1.

pe2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) padding of BsSpacing.s2.

pe3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) padding of BsSpacing.s3.

pe4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) padding of BsSpacing.s4.

pe5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies end (right) padding of BsSpacing.s5.

ps(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies padding only to the start (left) side.

ps0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero padding to the start side.

ps1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) padding of BsSpacing.s1.

ps2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) padding of BsSpacing.s2.

ps3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) padding of BsSpacing.s3.

ps4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) padding of BsSpacing.s4.

ps5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies start (left) padding of BsSpacing.s5.

pt(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies padding only to the top side.

pt0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero padding to the top side.

pt1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top padding of BsSpacing.s1.

pt2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top padding of BsSpacing.s2.

pt3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top padding of BsSpacing.s3.

pt4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top padding of BsSpacing.s4.

pt5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies top padding of BsSpacing.s5.

px(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal padding (left and right).

px0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero horizontal padding (left and right).

px1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal padding (left and right) of BsSpacing.s1.

px2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal padding (left and right) of BsSpacing.s2.

px3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal padding (left and right) of BsSpacing.s3.

px4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal padding (left and right) of BsSpacing.s4.

px5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies horizontal padding (left and right) of BsSpacing.s5.

py(double value) → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical padding (top and bottom).

py0() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies zero vertical padding (top and bottom).

py1() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical padding (top and bottom) of BsSpacing.s1.

py2() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical padding (top and bottom) of BsSpacing.s2.

py3() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical padding (top and bottom) of BsSpacing.s3.

py4() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical padding (top and bottom) of BsSpacing.s4.

py5() → Widget

Available on Widget, provided by the BsSpacingExtension extension

Applies vertical padding (top and bottom) of BsSpacing.s5.

rounded() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies a default border-radius of 0.375rem (6px), matching .rounded.

rounded0() → Widget

Available on Widget, provided by the BsBorderExtension extension

Removes all border-radius, matching .rounded-0.

rounded1() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies a small border-radius of 0.25rem (4px), matching .rounded-1.

rounded2() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies a medium border-radius of 0.375rem (6px), matching .rounded-2.

rounded3() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies a large border-radius of 0.5rem (8px), matching .rounded-3.

rounded4() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies an extra-large border-radius of 1rem (16px), matching .rounded-4.

rounded5() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies an extra-extra-large border-radius of 2rem (32px), matching .rounded-5.

roundedBottom({double radius = 6.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies border-radius only to the bottom side, matching .rounded-bottom.

roundedCircle() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies a circular border-radius, matching .rounded-circle.

roundedEnd({double radius = 6.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies border-radius only to the end (right) side, matching .rounded-end.

roundedPill() → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies a pill-like border-radius (large value), matching .rounded-pill.

roundedStart({double radius = 6.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies border-radius only to the start (left) side, matching .rounded-start.

roundedTop({double radius = 6.0}) → Widget

Available on Widget, provided by the BsBorderExtension extension

Applies border-radius only to the top side, matching .rounded-top.

size100() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets both width and height to 100% (double.infinity). Maps to Bootstrap's .w-100 and .h-100.

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

vh100(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets height to 100vh (100% of viewport height).

vh50(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets height to 50vh (50% of viewport height).

visible(bool visible) → Widget

Available on Widget, provided by the BsDisplayExtension extension

Shows or hides the widget based on visible.

vw100(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets width to 100vw (100% of viewport width).

vw50(BuildContext context) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets width to 50vw (50% of viewport width).

w(double width) → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets a fixed width for the widget.

w100() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the width to 100% (double.infinity).

w25() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the width to 25% of parent (FractionallySizedBox).

w50() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the width to 50% of parent (FractionallySizedBox).

w75() → Widget

Available on Widget, provided by the BsSizeExtension extension

Sets the width to 75% of parent (FractionallySizedBox).

Operators

operator ==(Object other) → bool

The equality operator.

inherited