iws_help 0.4.2

Add documentation pages and contextual help to widgets using the IWS service.

Add documentation pages and contextual help to widgets using the IWS service.

Features

• Wrap components with contextual help.
• Shows a list with all help topics.
• Shows a list with all the help available for a page.

Getting started

Add the IWS API key as a DART variable at compile time:

--dart-define=IWS_API_KEY=xxxxxxxxxxxxxx

Load help from server

IwsHelp().loadHelp();

Usage

Wrap components with contextual help

import 'package:iws_help/iws_help.dart';

    HelpIcon(
        helpKey: 'money',
        fullScreen: false,
        child: TextField(
            decoration: InputDecoration(labelText: 'Money'),
        )
    )

Displays a screen with available help

import 'package:iws_help/iws_help.dart';

    Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
        actions: const [
            GeneralHelpButton(label: 'More help'), 
            SizedBox(width: 10),
        ],
      ),
      body: _body()
    )