scroll_spy_flutter 0.0.6

SDKflutter
Platformandroidioswindowslinuxmacosweb

A Flutter widget that implements scroll spy functionality

Flutter Dynamic Scroll Spy

A Flutter widget that implements scroll spy functionality with a navigation bar and content area. Perfect for documentation, long-form content, and any UI that needs synchronized navigation with content.

Features

  • Automatic highlighting of navigation items based on scroll position
  • Smooth scrolling to content when navigation items are clicked
  • Customizable styles for active and inactive navigation items
  • Flexible layout with customizable width ratios
  • Supports both automatic and programmatic scrolling
  • Callbacks for navigation item selection and content visibility changes

divyeshdevmurari



Installation

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

dependencies:
  flutter_dynamic_scroll_spy: ^0.0.1

Usage

Import the package:

import 'package:flutter_dynamic_scroll_spy/scroll_spy_flutter.dart';

Basic usage:

DynamicScrollSpyWidget(
  headingList: ['Section 1', 'Section 2', 'Section 3'],
  contentList: [
    Container(child: Text('Content for Section 1')),
    Container(child: Text('Content for Section 2')),
    Container(child: Text('Content for Section 3')),
  ],
)

Advanced usage with all properties:

DynamicScrollSpyWidget(
  // Required properties
  headingList: ['Section 1', 'Section 2', 'Section 3'],
  contentList: [
    Container(child: Text('Content 1')),
    Container(child: Text('Content 2')),
    Container(child: Text('Content 3')),
  ],
  
  // Optional styling
  headingStyle: TextStyle(fontSize: 16),
  activeHeadingStyle: TextStyle(
    fontSize: 16,
    fontWeight: FontWeight.bold,
    color: Colors.blue,
  ),
  contentPadding: EdgeInsets.all(16),
  headingPadding: EdgeInsets.symmetric(vertical: 8, horizontal: 16),
  
  // Layout customization
  navigationFlex: 1,  // Takes up 1/4 of the width
  contentFlex: 3,    // Takes up 3/4 of the width
  
  // Callbacks
  onHeadingSelected: (index) {
    print('Heading $index was selected');
  },
  onContentVisible: (index) {
    print('Content $index is now most visible');
  },
)

Properties

PropertyTypeDescription
headingListList<String>List of headings to show in the navigation bar
contentListList<Widget>List of content widgets corresponding to each heading
headingStyleTextStyle?Style for inactive heading text
activeHeadingStyleTextStyle?Style for active heading text
contentPaddingEdgeInsets?Padding around content items
headingPaddingEdgeInsets?Padding around heading items
navigationFlexintFlex value for navigation bar width (default: 1)
contentFlexintFlex value for content area width (default: 3)
onHeadingSelectedFunction(int)?Callback when heading is clicked
onContentVisibleFunction(int)?Callback when content becomes most visible

Example

Here's a complete example showing how to use the widget in a documentation-style app:

import 'package:flutter/material.dart';
import 'package:flutter_dynamic_scroll_spy/scroll_spy_flutter.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Documentation')),
        body: DynamicScrollSpyWidget(
          headingList: [
            'Introduction',
            'Getting Started',
            'Basic Usage',
            'Advanced Features',
            'API Reference',
          ],
          contentList: [
            _buildSection('Introduction', 'Welcome to our documentation...'),
            _buildSection('Getting Started', 'First, install the package...'),
            _buildSection('Basic Usage', 'Here\'s a simple example...'),
            _buildSection('Advanced Features', 'Discover more capabilities...'),
            _buildSection('API Reference', 'Complete list of properties...'),
          ],
          headingStyle: const TextStyle(fontSize: 16),
          activeHeadingStyle: const TextStyle(
            fontSize: 16,
            fontWeight: FontWeight.bold,
            color: Colors.blue,
          ),
          navigationFlex: 1,
          contentFlex: 3,
        ),
      ),
    );
  }

  Widget _buildSection(String title, String content) {
    return Container(
      padding: const EdgeInsets.all(16),
      child: Column(
        crossAxisAlignment: CrossAxisAlignment.start,
        children: [
          Text(
            title,
            style: const TextStyle(
              fontSize: 24,
              fontWeight: FontWeight.bold,
            ),
          ),
          const SizedBox(height: 16),
          Text(
            content,
            style: const TextStyle(fontSize: 16),
          ),
          const SizedBox(height: 32),
        ],
      ),
    );
  }
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.