toml_viewer 0.0.3

A flutter library embeded TOML view.

TOML Viewer

A TOML viewer in Flutter is a user interface component that displays the contents of a TOML (Tom's Obvious, Minimal Language) file in a structured and readable format. This viewer typically parses the TOML file and presents its key-value pairs, tables, arrays, and nested structures in a visually appealing manner.

Key features of a TOML viewer in Flutter may include:

1. Parsing TOML: The viewer should be capable of parsing TOML files to extract their data for display.

2. Structured Display: It organizes the data from the TOML file in a structured manner, preserving hierarchy and relationships between keys and values.

3. Key-Value Presentation: Key-value pairs are displayed clearly, with keys and their corresponding values presented together.

4. Support for Tables and Arrays: If the TOML file contains tables or arrays, the viewer should appropriately display these structures, allowing users to expand and collapse them as needed.

5. Color Coding: Use of color coding to distinguish between different types of data (e.g., strings, integers, booleans) and to improve readability.

6. Interactive Features: Ability to interact with the displayed data, such as expanding or collapsing sections, tapping on entries for more information, or performing actions based on user input.

7. Customization: Options for customization, such as adjusting font sizes, colors, and themes to suit user preferences.

8. Error Handling: Graceful handling of errors in parsing the TOML file, with informative messages or indicators to alert users of any issues.

Overall, a TOML viewer in Flutter aims to provide users with a convenient way to visualize and explore the contents of TOML files directly within their Flutter applications.

import 'package:flutter/material.dart';
import 'package:toml_viewer/toml_viewer.dart';

void main() {
  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        body: SafeArea(
          child: Padding(
            padding: EdgeInsets.symmetric(horizontal: 14, vertical: 7),
            child: TomlView(assetFilePath: 'assets/test.toml'),
          ),
        ),
      ),
    );
  }
}

To address the issues in your provided code snippet and describe the customization of TomlViewerConfig, let's make corrections and clarify how you can customize the configuration when using TomlView.

Corrections and Explanation

First, let's correct the usage of TomlViewerConfig.copyWith and clarify how to properly customize the configuration for TomlView.

1. Fixing the Code

TomlView(
  assetFilePath: 'assets/test.toml',
  config: TomlViewerConfig().copyWith(expandMode: false),
)

In the corrected code:

• We instantiate a new TomlViewerConfig object using TomlViewerConfig().
• We then use the copyWith method to create a modified copy of the configuration by specifying expandMode: false.

2. Customization Details

The TomlViewerConfig class allows customization of various properties that affect the appearance and behavior of the TOML viewer. Here's a breakdown of the configurable properties:

Property Name	Default Value	Description
expandMode	true	Controls whether the tree view is expanded or collapsed by default.
valueColor	Color.fromRGBO(255, 68, 68, 1.0)	Defines the color for values in the TOML viewer.
typeTextColor	Colors.grey	Specifies the color for value type names displayed in the viewer.
symbolColor	Colors.grey	Determines the color for symbols (like '=' or ',') within the viewer.
nonRootKeyColor	const Color.fromRGBO(0, 51, 153, 1.0)	Sets the color for non-root keys in the viewer.
rootKeyColor	Color.fromRGBO(126, 43, 143, 1.0)	Specifies the color for root keys in the viewer.
keyColor	Color.fromRGBO(0, 128, 128, 1.0)	Defines the color for map keys other than root keys.

3. Customization Example

In the example usage provided:

• We instantiate TomlView with assetFilePath pointing to a TOML file ('assets/test.toml').
• We customize the configuration by setting expandMode to false using copyWith.

Screeshots

Bugs or Requests

If you come across any difficulties, don't hesitate to open an issue on GitHub. If you believe that the library lacks a particular feature, please create a ticket on GitHub, and I'll investigate it. Additionally, I welcome pull requests if you would like to contribute to the project.

Developer Information

Project Contributors

This project is actively developed and maintained by a dedicated team of contributors. If you have any questions, suggestions, or issues related to the project, feel free to reach out to any of our team members listed below.

Lead Developer

• Name: Sudhi S
• GitHub: sudhi001
• Email: [e-mail]

Contributors

We'd like to extend our gratitude to all the open-source contributors who have helped improve this project. Your contributions are greatly appreciated.

How to Contribute

We welcome contributions from the community to help improve this project. If you're interested in contributing, please follow these guidelines:

Before submitting a Pull Request, please make sure to:

• Follow the project's coding style and guidelines.
• Write clear and concise commit messages.
• Test your changes thoroughly.
• Update documentation if necessary.

Bug Reports and Feature Requests

If you encounter any bugs or have ideas for new features, please feel free to open an issue on GitHub. We appreciate your feedback and will do our best to address any concerns promptly.