vyuh_feature_onboarding

The onboarding feature supplies a content type, step data, and a default layout. It composes text, imagery, and actions using the normal content extension pipeline.

How the pieces fit together

Package source · Released API

Choose a declaration

DefaultOnboardingLayout · OnboardingContent · OnboardingContentBuilder · OnboardingDescriptor · OnboardingStep · feature

DefaultOnboardingLayout

Source

Public declaration in this package.

final class DefaultOnboardingLayout extends LayoutConfiguration<OnboardingContent>

Directly declared public members:

static const dynamic schemaName;

static final dynamic typeDescriptor;

DefaultOnboardingLayout();

factory DefaultOnboardingLayout.fromJson(Map<String, dynamic> json);

Widget build(BuildContext context, OnboardingContent content);

OnboardingContent

Source

Public declaration in this package.

final class OnboardingContent extends ContentItem

Directly declared public members:

static const dynamic schemaName;

static final dynamic typeDescriptor;

final Action? doneAction;

final List<OnboardingStep> steps;

OnboardingContent({this.doneAction, this.steps = const [], super.layout, super.modifiers});

factory OnboardingContent.fromJson(Map<String, dynamic> json);

OnboardingContentBuilder

Source

Public declaration in this package.

final class OnboardingContentBuilder extends ContentBuilder<OnboardingContent>

Directly declared public members:

OnboardingContentBuilder();

OnboardingDescriptor

Source

Public declaration in this package.

final class OnboardingDescriptor extends ContentDescriptor

Directly declared public members:

OnboardingDescriptor({super.layouts});

OnboardingStep

Source

Public declaration in this package.

final class OnboardingStep

Directly declared public members:

final String title;

final PortableTextContent? description;

final Widget? icon;

final ImageReference? image;

OnboardingStep({this.title = '', this.description, this.icon, this.image});

factory OnboardingStep.fromJson(Map<String, dynamic> json);

feature

Source

Public declaration in this package.

final feature = FeatureDescriptor( name: 'vyuh_feature_onboarding', title: 'Vyuh Feature Onboarding', description: 'Onboarding screens when user first opens the app.', icon: Icons.checklist, extensions: [ ContentExtensionDescriptor(contentBuilders: [OnboardingContentBuilder()]), ], routes: () => [], );