SparkPage class - spark library

Abstract base class for Spark pages.

Pages are the entry points for your application's routes. Each page must implement loader to fetch data and render to produce HTML.

The generic type T represents the data type returned by your loader. This provides type safety between your loader and render methods.

Basic Usage

@Page(path: '/users/:id')
class UserPage extends SparkPage<User> {
  @override
  Future<PageResponse<User>> loader(PageRequest request) async {
    final userId = request.pathParamInt('id');
    final user = await fetchUser(userId);
    if (user == null) return PageRedirect('/404');
    return PageData(user);
  }

  @override
  String render(User data, PageRequest request) {
    return '''
      <h1>${data.name}</h1>
      <p>${data.email}</p>
    ''';
  }
}

Pages Without Data

For pages that don't need to load data, use void as the type:

@Page(path: '/')
class HomePage extends SparkPage<void> {
  @override
  Future<PageResponse<void>> loader(PageRequest request) async {
    return PageData(null);
  }

  @override
  String render(void data, PageRequest request) {
    return '<h1>Welcome!</h1>';
  }
}

With Components (Islands)

@Page(path: '/counter')
class CounterPage extends SparkPage<void> {
  @override
  List<ComponentInfo> get components => [
    ComponentInfo('my-counter', Counter.new),
  ];

  @override
  Future<PageResponse<void>> loader(PageRequest request) async {
    return PageData(null);
  }

  @override
  String render(void data, PageRequest request) {
    return Counter(start: 0).render();
  }
}

Properties