Search packages, repositories and app categories

json_editor_flutter cover
Package detailsv1.4.2

json_editor_flutter

Edit your JSON object with the help of this package. Create and delete objects using this user friendly widget.

AndroidiOSWebmacOSWindowsLinux
30-day downloads
3.6K
Likes
31
Pub points
150

Install package

flutter pub add json_editor_flutter

Package Overview

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

json_editor_flutter is a user-friendly Flutter package that enables interactive editing of JSON objects within your app. It provides a clean, intuitive interface for creating, modifying, and deleting JSON keys and values. The widget supports real-time validation and nested object manipulation, making it ideal for developers who need to work with JSON data directly in their UI. With support across all major platforms, it integrates seamlessly into Flutter applications requiring dynamic JSON input.

Use cases

  • Editing configuration files
  • Debugging API responses
  • Building form builders
  • Creating JSON schema editors
  • Prototyping data structures

Key features

  • Interactive JSON tree view
  • Real-time validation
  • Support for nested objects
  • Cross-platform compatibility
  • Easy integration with Flutter forms

Suitable for

  • Developers building admin panels
  • App creators needing JSON input
  • Educational tools for learning JSON
  • Tools for API testing and debugging

Considerations

  • May require custom styling for complex layouts
  • Limited to basic JSON operations
  • Not optimized for very large JSON files
  • No built-in export/import functionality

Original README

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

JsonEditor class

Edit your JSON object with this package. Create, edit and format objects using this user friendly widget.

See the sample below for an example.

JsonEditor Live Demo

Screenshot

JsonEditor

Getting started

  • Add the package in your flutter project. Run this command in terminal flutter pub add json_editor_flutter.
  • Import the package import 'package:json_editor_flutter/json_editor_flutter.dart';.

Using JsonEditor

JSON can be edited in two ways, Tree editor or text editor. You can disable either of them.

When UI editor is active, you can disable adding/deleting keys by using enableMoreOptions. Editing keys and values can also be disabled by using enableKeyEdit and enableValueEdit.

When text editor is active, it will simply ignore enableMoreOptions, enableKeyEdit and enableValueEdit.

duration is the debounce time for onChanged function. Defaults to 500 milliseconds.

editors is the supported list of editors. First element will be used as default editor. Defaults to [Editors.tree, Editors.text].

Example

JsonEditor(
  onChanged: (value) {
    // Do something
  },
  json: jsonEncode({
    "name": "John Doe",
    "age": 24,
    "hobbies": ["Reading", "Coding"],
    "address": {
      "street": "Main Street",
      "number": 1234567890,
      "city": "New York"
    }
  }),
)

Enums

Supported editors for JSON Editor.

enum  Editors { tree, text }

Customization

expandedObjects

[expandedObjects] refers to the objects that will be expanded by default. Index can be provided when the data is a List.

data = {
  "hobbies": ["Reading books", "Playing Cricket"],
  "education": [
    {"name": "Bachelor of Engineering", "marks": 75},
    {"name": "Master of Engineering", "marks": 72},
  ],
}

For the given data

  1. To expand education pass => ["education"]
  2. To expand hobbies and education pass => ["hobbies", "education"]
  3. To expand the first element (index 0) of education list, this means we need to expand education too. In this case you need not to pass "education" separately. Just pass a list of all nested objects => [["education", 0]]
JsonEditor(
  expandedObjects: const [
    "hobbies",
    ["education", 0] // expands nested object in `education`
  ],
  onChanged: (_) {},
  json: jsonEncode(data),
)

Properties

Property Type Default Value Description
json String required JSON object to be edited
onChanged Function required Callback function that will be called with the new data
duration Duration 500 ms Debounce duration for onChanged function
enableMoreOptions bool true Enables more options like adding or deleting data
enableKeyEdit bool true Enables editing of keys
enableValueEdit bool true Enables editing of values
themeColor Color? null Theme color for the editor, changes the border color and header color
editors List [tree, text] List of supported editors, first element will be used as default editor
actions List<Widget> [] A list of Widgets to display in a row at the end of header
enableHorizontalScroll bool false Enables horizontal scroll for the tree view
searchDuration Duration 500 ms Debounce duration for search function
hideEditorsMenuButton bool false Hides the option of changing editor
expandedObjects List [] List of objects to expand by default

Additional information

You can raise an issue/feature request on github Json Editor Issues


Please leave a like if you find this package useful. :+1:

Categories

Source repository

Projects using this package

No data available yet.