Clarity Flutter SDK

https://pub.dev/packages/clarity_flutter
Admin
The official Clarity Flutter SDK for integrating Clarity analytics into Flutter applications,...
Tokens:3,312
Snippets:30
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example ClarityConfig Initialization

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

An example demonstrating how to initialize `ClarityConfig` with `projectId`, `userId`, and `logLevel` explicitly set, showcasing common configuration options.

```Dart
final config = ClarityConfig(
  projectId: "your_project_id",
  userId: "your_user_id",
  logLevel: LogLevel.Info,
);
```

--------------------------------

### Retrieve Dart and Flutter SDK Versions

Source: https://pub.dev/packages/clarity_flutter/score/log

Executes commands to display the installed versions of the Dart and Flutter SDKs. The Flutter command uses `--machine` for structured output, suitable for automated processing.

```Shell
dart --version
```

```Shell
flutter --no-version-check --version --machine
```

--------------------------------

### Manage Flutter Package Dependencies

Source: https://pub.dev/packages/clarity_flutter/score/log

A series of commands for managing a Flutter project's dependencies: fetching them (`pub get`), checking for outdated ones (`pub outdated`), and adjusting versions (`pub downgrade`, `pub upgrade`).

```Shell
flutter --no-version-check pub pub get --no-example
```

```Shell
flutter --no-version-check pub pub outdated --json --up-to-date --no-dev-dependencies --no-dependency-overrides
```

```Shell
flutter --no-version-check packages pub downgrade --no-example
```

```Shell
flutter --no-version-check packages pub upgrade --no-example
```

--------------------------------

### Configure Clarity Log Level for Troubleshooting in Flutter

Source: https://pub.dev/packages/clarity_flutter/index

Provides an example of setting the `logLevel` to `LogLevel.Verbose` in `ClarityConfig` to aid in troubleshooting. This increases the verbosity of Clarity-specific logs, helping diagnose initialization or data transmission issues.

```Dart
final config = ClarityConfig(
  projectId: "your_project_id",
  userId: "your_user_id",
  logLevel: LogLevel.Verbose,
);
```

--------------------------------

### Set Clarity Log Level to Verbose for Troubleshooting

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

Example of configuring `ClarityConfig` to set the `logLevel` to `LogLevel.Verbose` for detailed logging, which is useful for debugging initialization errors and verifying Clarity's operation.

```Dart
final config = ClarityConfig(
  projectId: "your_project_id",
  userId: "your_user_id",
  logLevel: LogLevel.Verbose,
);
```

--------------------------------

### Add Clarity Flutter SDK dependency using Flutter CLI

Source: https://pub.dev/packages/clarity_flutter/install

This command adds the `clarity_flutter` package as a dependency to your Flutter project. It automatically updates the `pubspec.yaml` file and runs an implicit `flutter pub get` to fetch the package.

```shell
$ flutter pub add clarity_flutter
```

--------------------------------

### Dart Static Analysis: Dangling Library Doc Comment in clarity_constants.dart

Source: https://pub.dev/packages/clarity_flutter/score

This snippet shows another static analysis warning (INFO level) for a 'Dangling library doc comment' located in `lib/src/clarity_constants.dart` starting at line 1. Similar to the previous warning, it highlights documentation comments that are not properly attached to a code element.

```Dart
/// Copyright (c) Microsoft Corporation.
/// Licensed under the MIT License.
```

--------------------------------

### Initialize Clarity Flutter SDK and Wrap Application

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

Demonstrates how to initialize the `ClarityConfig` object with your project ID and wrap your main Flutter application widget with `ClarityWidget` to enable Clarity tracking and session recording.

```Dart
import 'package:flutter/material.dart';
import 'package:clarity_flutter/clarity_flutter.dart';

void main() {
  final config = ClarityConfig(
    projectId: "your_project_id" // You can find it on the Settings page of Clarity dashboard.
  );

  runApp(ClarityWidget(
    app: MyApp(),
    clarityConfig: config,
  ));
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Clarity Flutter SDK Example'),
        ),
        body: Center(
          child: Text('Hello, Clarity!'),
        ),
      ),
    );
  }
}
```

--------------------------------

### Initialize Clarity Flutter SDK and Wrap Application

Source: https://pub.dev/packages/clarity_flutter/index

Demonstrates how to initialize the `ClarityConfig` with a `projectId` and wrap the main application widget (`MyApp`) with `ClarityWidget`. This sets up the Clarity SDK for data collection and session recording in a Flutter app.

```Dart
import 'package:flutter/material.dart';
import 'package:clarity_flutter/clarity_flutter.dart';

void main() {
  final config = ClarityConfig(
    projectId: "your_project_id" // You can find it on the Settings page of Clarity dashboard.
  );

  runApp(ClarityWidget(
    app: MyApp(),
    clarityConfig: config,
  ));
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Clarity Flutter SDK Example'),
        ),
        body: Center(
          child: Text('Hello, Clarity!'),
        ),
      ),
    );
  }
}
```

--------------------------------

### Generate Dart API Documentation

Source: https://pub.dev/packages/clarity_flutter/score/log

Activates the `dartdoc` tool globally and then executes it to generate comprehensive API documentation for the Flutter package, with options for output location, HTML sanitization, and file limits.

```Shell
flutter --no-version-check pub global activate dartdoc 8.3.4
```

```Shell
flutter --no-version-check pub global run dartdoc --output /tmp/pana-clarity_flutterNKGWQS/raw-dartdoc --sanitize-html --max-file-count 10000000 --max-total-size 2147483648 --no-validate-links --sdk-dir /home/worker/flutter/stable/bin/cache/dart-sdk
```

--------------------------------

### ClarityConfig Object API Reference

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

Detailed API reference for the `ClarityConfig` object, outlining its properties, types, descriptions, and constraints for configuring the Clarity Flutter SDK's behavior.

```APIDOC
ClarityConfig Object Properties:

projectId (String): The unique identifier for your Clarity project. You can find it on the Settings page of Clarity dashboard. This ID is essential for routing data to the correct Clarity project.

userId (String, optional): The unique identifier for the user. Must be a base-36 string larger than 0 and smaller than `1z141z4`. If not provided, a Clarity generated user ID will be used instead.

logLevel (LogLevel, optional): The logging level for Clarity. Defaults to `LogLevel.Info` if not provided (in debug builds). In non-debug (production) builds, `loglevel` is forced to `None` to eliminate any performance overhead.

  Possible LogLevel values:
    LogLevel.Verbose: Detailed debug information.
    LogLevel.Debug: Debug information.
    LogLevel.Info: Informational messages.
    LogLevel.Warn: Warning messages.
    LogLevel.Error: Error messages.
    LogLevel.None: No logging.
```

--------------------------------

### ClarityConfig Object API Reference and Configuration

Source: https://pub.dev/packages/clarity_flutter/index

Provides a detailed API reference for the `ClarityConfig` object, outlining its properties such as `projectId` (required), `userId` (optional), and `logLevel` (optional, with `LogLevel` enum values). It explains the purpose and constraints of each configuration option for the Clarity Flutter SDK.

```APIDOC
ClarityConfig object:
  - projectId (String): The unique identifier for your Clarity project. Required.
  - userId (String, optional): The unique identifier for the user. Must be a base-36 string larger than 0 and smaller than `1z141z4`. If not provided, a Clarity generated user ID will be used instead.
  - logLevel (LogLevel, optional): The logging level for Clarity. Defaults to `LogLevel.Info` in debug builds. In non-debug (production) builds, `loglevel` is forced to `None`.
    Possible LogLevel values:
    - LogLevel.Verbose: Detailed debug information.
    - LogLevel.Debug: Debug information.
    - LogLevel.Info: Informational messages.
    - LogLevel.Warn: Warning messages.
    - LogLevel.Error: Error messages.
    - LogLevel.None: No logging.

Example Usage:
final config = ClarityConfig(
  projectId: "your_project_id",
  userId: "your_user_id",
  logLevel: LogLevel.Info,
);
```

--------------------------------

### Import Clarity Flutter Package in Dart

Source: https://pub.dev/packages/clarity_flutter/index

Shows how to import the `clarity_flutter` package into a Dart file, typically `main.dart`, to make its functionalities available for use within the application.

```Dart
import 'package:clarity_flutter/clarity_flutter.dart';
```

--------------------------------

### Add Clarity Flutter Dependency to pubspec.yaml

Source: https://pub.dev/packages/clarity_flutter/index

Instructions to add the `clarity_flutter` package as a dependency in the `pubspec.yaml` file, specifying its version. This is the first step for integrating the SDK into a Flutter project.

```YAML
dependencies:
  clarity_flutter: 1.0.0
```

--------------------------------

### Perform Dart Code Static Analysis

Source: https://pub.dev/packages/clarity_flutter/score/log

Runs the Dart analyzer on the project's `lib` directory to identify potential issues, warnings, and errors. The output is formatted for machine readability.

```Shell
dart analyze --format machine lib
```

--------------------------------

### Add Clarity Flutter SDK Dependency

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

To integrate the Clarity Flutter SDK into your project, add the following line to your pubspec.yaml file under the 'dependencies:' section. This specifies the package and its version for your Flutter application.

```YAML
clarity_flutter: ^1.0.0
```

--------------------------------

### Unpack Flutter Package for Analysis

Source: https://pub.dev/packages/clarity_flutter/score/log

Unpacks a specific version of a Flutter package to a temporary directory without resolving its dependencies, preparing it for further analysis by tools like `pana`.

```Shell
dart pub unpack clarity_flutter:1.0.0 --output /tmp/pana-clarity_flutterNKGWQS/clarity_flutter --no-resolve
```

--------------------------------

### Add Clarity Flutter Dependency to pubspec.yaml

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

Instructions to add the `clarity_flutter` package as a dependency in your Flutter project's `pubspec.yaml` file, specifying the version.

```YAML
dependencies:
  clarity_flutter: 1.0.0
```

--------------------------------

### Identify Git Repository Root

Source: https://pub.dev/packages/clarity_flutter/score/log

Uses Git to determine and output the absolute path of the current repository's top-level directory, a common operation in build and analysis scripts.

```Shell
git rev-parse --show-toplevel
```

--------------------------------

### Import Clarity Flutter Package in Dart

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

Import the `clarity_flutter` package into your Dart files, typically `main.dart`, to access its functionalities and classes like `ClarityConfig` and `ClarityWidget`.

```Dart
import 'package:clarity_flutter/clarity_flutter.dart';
```

--------------------------------

### Declare Clarity Flutter SDK dependency in pubspec.yaml

Source: https://pub.dev/packages/clarity_flutter/install

This YAML configuration snippet shows how the `clarity_flutter` package dependency is declared in the `pubspec.yaml` file. The `^1.0.0` indicates a compatible version range, allowing minor updates.

```yaml
dependencies:
  clarity_flutter: ^1.0.0
```

--------------------------------

### Format Dart Source Code

Source: https://pub.dev/packages/clarity_flutter/score/log

Applies Dart's standard formatting rules to source files. The command is configured to only report if changes are needed without modifying files, exiting with an error code if formatting is required.

```Shell
dart format --output=none --set-exit-if-changed /tmp/pana_JCIZCC/./lib
```

--------------------------------

### Import Clarity Flutter SDK in Dart code

Source: https://pub.dev/packages/clarity_flutter/install

This Dart import statement makes the `clarity_flutter` package available for use within your Dart files. It allows you to access the functionalities and classes provided by the SDK.

```dart
import 'package:clarity_flutter/clarity_flutter.dart';
```

--------------------------------

### Downgrade Dart Package Dependencies

Source: https://pub.dev/packages/clarity_flutter/score

This command attempts to downgrade package dependencies to their lower bounds. It is primarily used for compatibility testing, specifically to check if the project's static analysis encounters any errors when dependencies are at their minimum specified versions. This helps ensure robustness across different dependency versions.

```Shell
pub downgrade
```

--------------------------------

### Check Dart Package Outdated Dependencies

Source: https://pub.dev/packages/clarity_flutter/score

This command is used to check for outdated direct and transitive dependencies in a Dart or Flutter project. It specifically excludes development dependencies and ensures that all listed dependencies are up-to-date without overriding any existing constraints. This helps maintain project stability and compatibility.

```Shell
dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides
```

--------------------------------

### Unmask Specific Widgets with ClarityUnmask in Flutter

Source: https://pub.dev/packages/clarity_flutter/index

Shows how to use the `ClarityUnmask` widget to reveal specific content within an otherwise masked area. This allows selective unmasking of non-sensitive information when a broader masking mode is applied.

```Dart
import 'package:flutter/material.dart';
import 'package:clarity_flutter/clarity_flutter.dart';

class UnmaskedWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ClarityUnmask(
      child: Text('Non-sensitive Information'),
    );
  }
}
```

--------------------------------

### Dart Static Analysis: Dangling Library Doc Comment in clarity_flutter.dart

Source: https://pub.dev/packages/clarity_flutter/score

This snippet illustrates a static analysis warning (INFO level) indicating a 'Dangling library doc comment' found in `lib/clarity_flutter.dart` at line 1. This lint suggests that a documentation comment is not correctly associated with a library, class, or function declaration.

```Dart
/// Copyright (c) Microsoft Corporation.
```

--------------------------------

### Mask Sensitive Information with ClarityMask Widget in Flutter

Source: https://pub.dev/packages/clarity_flutter/index

Illustrates the use of the `ClarityMask` widget to obscure sensitive information within the UI. Any child widget wrapped by `ClarityMask` will have its content masked in Clarity recordings.

```Dart
import 'package:flutter/material.dart';
import 'package:clarity_flutter/clarity_flutter.dart';

class MaskedWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ClarityMask(
      child: Text('Sensitive Information'),
    );
  }
}
```

--------------------------------

### Mask Sensitive Information with ClarityMask Widget

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

Demonstrates how to use the `ClarityMask` widget to prevent sensitive child widgets from being captured by Clarity, ensuring data privacy for specific UI elements.

```Dart
import 'package:flutter/material.dart';
import 'package:clarity_flutter/clarity_flutter.dart';

class MaskedWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ClarityMask(
      child: Text('Sensitive Information'),
    );
  }
}
```

--------------------------------

### Unmask Widgets within Masked Areas with ClarityUnmask

Source: https://pub.dev/packages/clarity_flutter/versions/1.0

Illustrates the use of `ClarityUnmask` to explicitly allow specific child widgets to be captured by Clarity, even if they are nested within a parent area that is otherwise masked.

```Dart
import 'package:flutter/material.dart';
import 'package:clarity_flutter/clarity_flutter.dart';

class UnmaskedWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ClarityUnmask(
      child: Text('Non-sensitive Information'),
    );
  }
}
```
Tokens:
Raw