https://github.com/rakuyokit/jsonpreview
🎨 A view that previews JSON in highlighted form, it also provides the ability to format and collapse nodes.
https://github.com/rakuyokit/jsonpreview
cocoapods collapse highlight ios json json-preview swift swift-package-manager swift5
Last synced: 11 months ago
JSON representation
🎨 A view that previews JSON in highlighted form, it also provides the ability to format and collapse nodes.
- Host: GitHub
- URL: https://github.com/rakuyokit/jsonpreview
- Owner: RakuyoKit
- License: mit
- Created: 2020-09-09T08:57:20.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T09:02:30.000Z (about 1 year ago)
- Last Synced: 2025-07-14T07:53:03.450Z (11 months ago)
- Topics: cocoapods, collapse, highlight, ios, json, json-preview, swift, swift-package-manager, swift5
- Language: Swift
- Homepage:
- Size: 5.85 MB
- Stars: 72
- Watchers: 3
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
`JSONPreview` is a JSON preview component that allows you to **format** your JSON data and display it with **syntax highlighting**. Additionally, `JSONPreview` offers **fold and expand** functionality, allowing you to collapse nodes you're not currently focusing on and re-display them at any time.
`JSONPreview` inherits from `UIView` and implements related features based on `UITextView`. The entire framework is entirely implemented based on native frameworks, which means when using this framework on Apple platforms, you can achieve a better user experience.
## Preview
Below is a roughly 25-second gif (**approximately 2.5M**) demonstrating the effect of previewing JSON using this library.
## Installation
### CocoaPods
```ruby
pod 'JSONPreview'
```
### Swift Package Manager
- Select File > Swift Packages > Add Package Dependency
- Add https://github.com/RakuyoKit/JSONPreview.git
- Select "Up to Next Major" with "2.3.3"
Or add the following content to your `Package.swift` file:
```swift
dependencies: [
.package(url: "https://github.com/RakuyoKit/JSONPreview.git", from: "2.3.3")
]
```
## Features
- [x] Support for **formatting** JSON data.
- [x] Support for syntax **highlighting** of JSON data, offering various color and font configuration options.
- [x] **fold and expand** functionality for `Array` and `Object` (except tvOS).
- [x] Allow setting the initial state of nodes, `.folded` or `.expand`.
- [x] Implemented based on `UITextView`. This means you can copy any content from `JSONPreview`.
- [x] Search the contents of JSON using text.
- [x] Switch between displaying JSON with or without wrapping lines at any time.
> Additional Details:
> 1. `JSONPreview` provides limited and incomplete formatting checks, so this feature is not offered as a primary function. Details can be found in: [Format check](#format-check).
> 2. Version [1.2.0](https://github.com/RakuyoKit/JSONPreview/releases/tag/1.2.0) added support for rendering links. Alongside rendering, `JSONPreview` performs limited unescaping: supporting replacing `"\\/"` with `"/"`.
## Usage
> After downloading the project, the [Demo](Demo) directory contains sample projects. You can run the project to see the corresponding effects.
### Basic Usage and Default Configuration
1. Create a `JSONPreview` object and add it to the interface:
```swift
let previewView = JSONPreview()
view.addSubview(previewView)
```
2. Call the `JSONPreview.preview` method to preview the data with the default style:
```swift
let json = "{\"key\":\"value\"}"
previewView.preview(json)
```
### Custom Styles
If you want to customize the syntax highlighting style, you can set it using `HighlightStyle` and `HighlightColor`:
> [`ConvertibleToColor`](Sources/Entity/HighlightColor.swift#L126) is a protocol for providing colors. Through this protocol, you can directly use `UIColor` objects or easily convert values like `0xffffff`, `#FF7F20` and `[0.72, 0.18, 0.13]` into `UIColor` objects.
```swift
let highlightColor = HighlightColor(
keyWord: ConvertibleToColor,
key: ConvertibleToColor,
link: ConvertibleToColor,
string: ConvertibleToColor,
number: ConvertibleToColor,
boolean: ConvertibleToColor,
null: ConvertibleToColor,
unknownText: ConvertibleToColor,
unknownBackground: ConvertibleToColor,
searchHitBackground: ConvertibleToColor?,
jsonBackground: ConvertibleToColor,
lineBackground: ConvertibleToColor,
lineText: ConvertibleToColor
)
let style = HighlightStyle(
expandIcon: UIImage?,
foldIcon: UIImage?,
color: highlightColor,
lineFont: UIFont?,
jsonFont: UIFont?,
lineHeight: CGFloat,
boldedSearchResult: Bool
)
previewView.preview(json, style: style)
```
You can also configure the `initialState` parameter to set the initial state of JSON child nodes.
```swift
// By default, all nodes are initially in a collapsed state during preview.
previewView.preview(json, style: style, initialState: .folded)
```
## Format Check
When rendering JSON, `JSONPreview` performs **limited** formatting checks.
Known conditions that trigger "error rendering" include:
- Values of unconventional JSON types. Supported types are `object`, `array`, `number`, `bool`, `string`, and `null`.
- Checking for formatting in `number`, such as scientific notation and decimals.
- Spelling check for `true`, `false`, and `null`.
- For scientific notation, the next node after `{E/e}` must be `+`, `-`, or a digit.
- Missing `,` separators between elements in an `array`.
- Missing `,` separators between elements in an `object`.
- No `:` after a key in an `object`.
- `object` has `:` after a key but lacks a value.
- Keys in `object` are not strings.
Apart from the explicitly mentioned conditions, other errors might trigger "error rendering". Additionally, there could be some errors outside the scope of formatting checks that might **result in missing content** in the JSON.
It's recommended not to overly rely on the formatting check feature of `JSONPreview` and to use it for previewing correctly formatted JSON as much as possible.
## Data Flow Diagram
## Contribution
You might feel that updates to `JSONPreview` are infrequent, but rest assured, this project has not been abandoned or stopped - I am still following it.
If you encounter any issues while using it, please feel free to [let me know](https://github.com/RakuyoKit/JSONPreview/issues/new?template=Blank+issue), and I’ll respond and assist as soon as possible.
Additionally, if you’d like to submit a PR, please base your development on the [`develop`](https://github.com/RakuyoKit/JSONPreview/tree/develop) branch before submitting your code. Thank you for your support and contributions!
## Thanks
Thanks to [Awhisper](https://github.com/Awhisper) for valuable insights during the development of `JSONPreview`.
## License
`JSONPreview` is available under the **MIT** license. For more information, see [LICENSE](LICENSE).