Pakete, Repositories und App-Kategorien suchen

Cover von json_editor_flutter
Paketdetailsv1.4.2

json_editor_flutter

Bearbeiten Sie Ihr JSON-Objekt mit Hilfe dieses Pakets. Erstellen und löschen Sie Objekte mithilfe dieser benutzerfreundlichen Widget.

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
3560
Likes
31
Pub-Punkte
150

Paket installieren

flutter pub add json_editor_flutter

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

json_editor_flutter ist ein benutzerfreundliches Flutter-Paket, das die interaktive Bearbeitung von JSON-Objekten in Ihrer App ermöglicht. Es bietet eine saubere und intuitive Oberfläche zum Erstellen, Ändern und Löschen von JSON-Schlüsseln und Werten. Das Widget unterstützt Echtzeit-Validierung und die Manipulation verschachtelter Objekte, wodurch es ideal für Entwickler wird, die direkt in ihrer Benutzeroberfläche mit JSON-Daten arbeiten müssen. Mit Unterstützung für alle wichtigen Plattformen lässt es sich nahtlos in Flutter-Anwendungen integrieren, die dynamische JSON-Eingaben erfordern.

Anwendungsfälle

  • Konfigurationsdateien bearbeiten
  • Debugging von API-Antworten
  • Formularersteller erstellen
  • JSON-Schema-Editoren erstellen
  • Prototyping-Datenstrukturen

Hauptmerkmale

  • Interaktive JSON-Baumansicht
  • Echtzeit-Validierung
  • Unterstützung für verschachtelte Objekte
  • Plattformübergreifende Kompatibilität
  • Einfache Integration mit Flutter-Formularen

Geeignet für

  • Entwickler, die Administrationspanele erstellen
  • App-Ersteller, die JSON-Eingabe benötigen
  • Lernwerkzeuge für das Erlernen von JSON
  • Werkzeuge für die API-Tests und -Debugging

Hinweise

  • Kann benutzerdefinierte Stile für komplexe Layouts erfordern
  • Beschränkt auf grundlegende JSON-Operationen
  • Nicht für sehr große JSON-Dateien optimiert
  • Keine integrierte Export-/Importfunktion

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

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:

Kategorien

Quell-Repository

Projekte, die dieses Paket verwenden

Noch keine Daten verfügbar.