Search packages, repositories and app categories

Package detailsv2.0.6

fluri

Fluri is a fluent URI library built to make URI mutation easy.

AndroidiOSWebmacOSWindowsLinux
30-day downloads
30.3K
Likes
6
Pub points
140

Install package

flutter pub add fluri

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

Fluri is a fluent URI library designed to simplify URI manipulation in Dart and Flutter applications. It provides an intuitive, chainable API for building, modifying, and parsing URIs with ease. Developers can seamlessly append paths, query parameters, and fragments while maintaining clean, readable code. Built by Workiva, Fluri supports all major platforms including Android, iOS, Web, macOS, Windows, and Linux, making it ideal for cross-platform projects requiring robust URL handling.

Use cases

  • Building dynamic API endpoints
  • Parsing and modifying URLs at runtime
  • Constructing complex query strings
  • Handling relative and absolute URIs
  • Testing HTTP clients with varied URLs
  • Managing navigation routes with parameters

Key features

  • Fluent, chainable API
  • Support for query parameter mutation
  • Easy path and fragment manipulation
  • Cross-platform compatibility
  • Immutable URI construction
  • Robust parsing and serialization

Suitable for

  • Flutter developers needing flexible URI handling
  • API clients requiring dynamic endpoint generation
  • Apps with complex routing or deep linking
  • Teams prioritizing clean, maintainable URL logic
  • Projects targeting multiple platforms

Considerations

  • Not intended for low-level URL parsing
  • Requires understanding of URI structure
  • May add overhead for simple static URLs
  • Limited to URI-specific operations
  • Best used in conjunction with HTTP clients like dio or http

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

fluri

Pub Build Status documentation

Examples/Usage

Fluri is a fluent URI library for Dart built to make URI mutation easy.

The dart:core.Uri class provides an immutable representation of URIs, which makes it difficult to incrementally build them or update them at a later time. If you wanted to build a long URI from the individual pieces, you would do something like this:

var uri = Uri(
  scheme: 'https',
  host: 'example.com',
  path: 'path/to/resource'
);

If you later wanted to update the path and add a query parameter, you'd have to do this:

uri = uri.replace(
  path: 'new/path',
  query: 'foo=true'
);

Now let's say you want update the query without losing what you already have:

var query = Map.from(uri.queryParameters);
query['bar'] = '10';
uri = uri.replace(queryParameters: query);

As you can see, incremental or fluent-style URI mutations become a hassle with the core Uri class.

With fluri, the above interactions are easy:

import 'package:fluri/fluri.dart';

var fluri = Fluri()
  ..scheme = 'https'
  ..host = 'example.com'
  ..path = 'path/to/resource';

fluri
  ..path = 'new/path'
  ..query = 'foo=true';

fluri.updateQuery({'bar': '10'});

Additional methods like appendToPath and setQueryParam make it easy to build on top of a base URL:

import 'package:fluri/fluri.dart';

var base = Fluri('https://example.com/base/');

var fluri = Fluri.from(base)
  ..appendToPath('path/to/resource')
  ..setQueryParam('count', '10');

Fluri also supports multi-value parameters. To access the query parameters as Map<String, List<String>>, use queryParametersAll (just like the Uri class):

var fluri = Fluri('/resource?format=json&format=text');
print(fluri.queryParameters); // {'format': 'text'}
print(fluri.queryParametersAll); // {'format': ['json', 'text']}

To set a single query parameter to multiple values:

var fluri = Fluri('/resource');
fluri.setQueryParam('format', ['json', 'text']);
print(fluri.queryParametersAll); // {'format': ['json', 'text']}

Using setQueryParam will always replace existing values:

var fluri = Fluri('/resource');
fluri.setQueryParam('format', ['json', 'text']);
fluri.setQueryParam('format', ['binary', 'text']);
print(fluri.queryParametersAll); // {'format': ['binary', 'text']}

You can use the queryParametersAll setter to set the entire query with multi-value param support:

var fluri = Fluri('/resource');
fluri.queryParametersAll = {'format': ['json', 'text'], 'count': ['5']}
print(fluri.queryParametersAll); // {'format': ['json', 'text'], 'count': ['5']}

Again, if you need to preserve existing query parameters, you can use the updateQuery method to do so. Set mergeValues: true and any values that you provide will be merged with existing values:

var fluri = Fluri('/resource?format=json');
fluri.updateQuery({'format': ['binary', 'text'], 'count': '5'}, mergeValues: true);
print(fluri.queryParametersAll); // {'format': ['binary', 'json', 'text'], 'count': ['5']}

Categories

Source repository

Projects using this package