These settings are available when checking the option to export properties that are not used.

The following is taken from my TypeScript def.

type Layer = {
  /** Enable motion blur for layer. Default is false. */
  mb?: boolean;
  /* ... Layer properties ... */
}

type Animation = {
  /** Motion blur setting. Default is undefined. */
  mb?: MotionBlurSettings;
  /* ... Animation properties ... */
}

/**
 * Motion Blur Settings
 * Enable motion blur for a layer by setting `layer.mb = true`
 */
type MotionBlurSettings = {
  /** Shutter angle. Default 0. */
  sa?: number;
  /** Shutter phase. Default 0. */
  sp?: number;
  /** Samples per frame. Default 1. */
  spf?: number;
  /** ??? unknown usage */
  asl?: number;
};

All auto-generating Typescript tools such as https://github.com/quicktype/quicktype use title to name Interfaces or Types. Thus, it is very important how we name titles, so we could help others automate without editing. Thus, this PR is meant to improve existing titles' duplications and inconsistencies identified by running auto-generating-type tools. In addition, better titles would be more clear for readers.

Changes:

1. rename duplication namings in different properties. e.g. the title "value" should be unique for s and v props
2. some additional files have been created to connect reused titles for the same properties: 2.1. /animated-properties/animated 2.2. /helpers/property-index 2.3. /animated-properties/expression 2.4 /helpers/framerate 2.5 /helpers/name 2.6 /helpers/match-name 2.7 /helpers/three-dimensional 2.8 created files for each Shape ty key
3. remove some properties if they cover under $ref
4. add an additional prefix/suffix word into the name if it's too generic to avoid future conflicts. e.g. title "Normal"
5. add a note about title prop importance in CONTRIBUTING.md

Suggestion: perhaps we can squash all commits before merging since there are so many of them

• the nav menu at the is very far to the side.
• the JSON editor is not centered, unlike other pages
• in advanced_interactions the examples are way too large

There is a duplicate property name in "Soften" and "Shadow Opacity". File: https://github.com/LottieFiles/lottie-docs/blob/main/docs/schema/styles/bevel-emboss-style.json

Hi!

In the latest bodymovin exporter it's possible to export frame rate for precomps.

The property is Precomposition.fr and contains a number if it exists.

Here's an example Lottie JSON exported with Bodymovin 5.8.0.

{
  "v": "5.8.0",
  "fr": 30,
  "ip": 0,
  "op": 30,
  "w": 540,
  "h": 960,
  "nm": "Comp 1",
  "ddd": 0,
  "assets": [
    {
      "id": "comp_0",
      "nm": "Shape Layer 1 Comp 1",
      "fr": 5,
      "layers": [
        {
          "ddd": 0,
          "ind": 1,
          "ty": 4,
          "nm": "Shape Layer 1",
          "sr": 1,
          "ks": {
            "o": { "a": 0, "k": 100, "ix": 11 },
            "r": { "a": 0, "k": 0, "ix": 10 },
            "p": {
              "a": 1,
              "k": [
                {
                  "i": { "x": 0.833, "y": 0.833 },
                  "o": { "x": 0.167, "y": 0.167 },
                  "t": 0,
                  "s": [79, 268, 0],
                  "to": [65.833, 70.333, 0],
                  "ti": [-65.833, -70.333, 0]
                },
                { "t": 28.99951171875, "s": [474, 690, 0] }
              ],
              "ix": 2,
              "l": 2
            },
            "a": { "a": 0, "k": [0, 0, 0], "ix": 1, "l": 2 },
            "s": { "a": 0, "k": [100, 100, 100], "ix": 6, "l": 2 }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "rc",
              "d": 1,
              "s": { "a": 0, "k": [100, 100], "ix": 2 },
              "p": { "a": 0, "k": [0, 0], "ix": 3 },
              "r": { "a": 0, "k": 0, "ix": 4 },
              "nm": "Rectangle Path 1",
              "mn": "ADBE Vector Shape - Rect",
              "hd": false
            },
            {
              "ty": "fl",
              "c": { "a": 0, "k": [1, 0, 0, 1], "ix": 4 },
              "o": { "a": 0, "k": 100, "ix": 5 },
              "r": 1,
              "bm": 0,
              "nm": "Fill 1",
              "mn": "ADBE Vector Graphic - Fill",
              "hd": false
            }
          ],
          "ip": 0,
          "op": 30,
          "st": 0,
          "cp": true,
          "bm": 0
        }
      ]
    }
  ],
  "layers": [
    {
      "ddd": 0,
      "ind": 1,
      "ty": 0,
      "nm": "Shape Layer 1 Comp 1",
      "refId": "comp_0",
      "sr": 1,
      "ks": {
        "o": { "a": 0, "k": 100, "ix": 11 },
        "r": { "a": 0, "k": 0, "ix": 10 },
        "p": { "a": 0, "k": [270, 480, 0], "ix": 2, "l": 2 },
        "a": { "a": 0, "k": [270, 480, 0], "ix": 1, "l": 2 },
        "s": { "a": 0, "k": [100, 100, 100], "ix": 6, "l": 2 }
      },
      "ao": 0,
      "w": 540,
      "h": 960,
      "ip": 0,
      "op": 30,
      "st": 0,
      "cp": false,
      "bm": 0
    }
  ],
  "markers": [],
}

Seems like the reference file is missing: https://github.com/LottieFiles/lottie-docs/blob/main/docs/schema/text/character-data.json#L42? or maybe it should be another shape reference? Sorry, I'm not very familiar.

The naming of a git tag and a branch name cannot be the same. Currently, the repo has a tag name called main which is conflicting with the master branch name. Thus, I'm getting this git error and not able to push any commits until I delete the tag manually:

Seems like https://github.com/LottieFiles/lottie-docs/blob/main/docs/schema/shapes/modifier.json is not necessary or incomplete?

1. Modifier's ty equals to null and it is not part of the ShapeType in https://github.com/LottieFiles/lottie-docs/blob/main/docs/schema/shapes/shape-element.json#L19?
2. A shape that extends shape/modifier overwrites ty anyway, for example, in shapes/repeater: https://github.com/LottieFiles/lottie-docs/blob/main/docs/schema/shapes/repeater.json#L13

Thus, should we delete shapes/modifier and extend shapes/shape-element instead of it?

Welcome to Renovate! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.

Detected Package Files

• .github/workflows/pages.yml (github-actions)
• .github/workflows/release.yml (github-actions)
• .github/workflows/test.yml (github-actions)
• theme/main.html (html)
• codemirror/package.json (npm)
• requirements.txt (pip_requirements)

Configuration Summary

Based on the default config's presets, Renovate will:

• Start dependency updates only once this onboarding PR is merged
• Enable Renovate Dependency Dashboard creation.
• If Renovate detects semantic commits, it will use semantic commit type fix for dependencies and chore for all others.
• Ignore node_modules, bower_components, vendor and various test/tests directories.
• Autodetect whether to pin dependencies or maintain ranges.
• Rate limit PR creation to a maximum of two per hour.
• Limit to maximum 10 open PRs at any time.
• Group known monorepo packages together.
• Use curated list of recommended non-monorepo package groupings.
• A collection of workarounds for known problems with packages.

🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the renovate.json in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs.

What to Expect

With your current configuration, Renovate will create 7 Pull Requests:

🚸 Branch creation will be limited to maximum 2 per hour, so it doesn't swamp any CI resources or spam the project. See docs for prhourlylimit for details.

❓ Got questions? Check out Renovate's Docs, particularly the Getting Started section. If you need any further assistance then you can also request help here.

This PR has been generated by Mend Renovate. View repository job log here.

Would be nice to share links on the json editor so that we can share the json view to others. One way is to have the URL to accept query parameter (maybe perhaps in base64 encoded) and in which it would decrypt the json and paste in the viewer.

According to lottie-docs/schema, the np (NumberOfProperties) prop doesn't exists in "custom-effects", but there is one in

• https://github.com/LottieFiles/lottie-docs/blob/main/docs/examples/effects-bulge.json#L76
• https://github.com/LottieFiles/lottie-docs/blob/main/docs/examples/effects-matte3-image.json#L41
• https://github.com/LottieFiles/lottie-docs/blob/main/docs/examples/effects-matte3.json#L65
• https://github.com/LottieFiles/lottie-docs/blob/main/docs/examples/effects-wave.json#L76

JSON_EDITOR throws errors as well

Hello!

I was trying to find unknown features, and got this as result:

/Users/liyushen/Documents/code/lottie-docs/docs/scripts/lottie_explain.js:1576
    module.exports = { SchemaData, SchemaObject };
                                   ^
ReferenceError: SchemaObject is not defined
    at Object.<anonymous> (/Users/liyushen/Documents/code/lottie-docs/docs/scripts/lottie_explain.js:1576:36)
    at Module._compile (node:internal/modules/cjs/loader:1218:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1272:10)
    at Module.load (node:internal/modules/cjs/loader:1081:32)
    at Module._load (node:internal/modules/cjs/loader:922:12)
    at Module.require (node:internal/modules/cjs/loader:1105:19)
    at require (node:internal/modules/cjs/helpers:103:18)
    at Object.<anonymous> (/Users/liyushen/Documents/code/lottie-docs/tools/unknown_features.js:4:15)
    at Module._compile (node:internal/modules/cjs/loader:1218:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1272:10)

Node.js v19.3.0

And my python virtual environment seems fine: It seems like there is no SchemaObject in lottie_examplain.js. I wonder which part did I do is wrong and how to fix this?

Conventionally schema title matches the $ref, in this case the title update did not reflect accordingly

"text-range": {
    "type": "object",
    "title": "Text Selector",
    "description": "Range of text with custom animations and style",
    "caniuse": "animators-range-selectors",
    "properties": {
        "nm": {
            "title": "Name",
            "type": "string"
        },
        "s": {
            "title": "Selector",
            "$ref": "#/$defs/text/text-range-selector"
        },
        "a": {
            "title": "Style",
            "$ref": "#/$defs/text/text-style"
        }
    }
}

According to lottie-docs/schema, asset-precomposition doesn't have mn (match-name) but it exists in https://github.com/LottieFiles/lottie-docs/blob/main/docs/examples/remapping.json#L13

should it be removed?

https://lottiefiles.github.io/lottie-docs/playground/json_editor/ doesn't recognize rotaiton related properties ("rx", "ry", "rz") and Orientation ("or")

example file: https://github.com/LottieFiles/lottie-docs/blob/main/docs/examples/3d_parenting.json

This is because there's already a lot of documentation for creating and using lottie animations, while this aims at providing a description of the file format itself.

It would really be helpful if some of these resources were listed as to make this statement you must be aware of what these resources are and people coming to this, like myself, don't 😭

Thank you <3

Running tools/schema-info.py I could get a summary of differences between this schema and the lottie community one.

Command:

tools/schema-info.py c $path_to_tests/schema/docs/json/

Properties and such marked with - are present here but not in the community schema, stuff marked with + is the other way round.

At the end I also added the files that haven't been matched (note: there will always be some differences due to the different schema structure).

animation/animation animation
properties:
 - mb
 - mn
 - fonts
 - markers
 - meta

effect-values/angle effects/angle
required:
 - ty

effect-values/checkbox effects/checkBox
required:
 - ty

effect-values/color effects/color
required:
 - ty

effect-values/drop-down effects/dropDown
required:
 - ty

effects/fill-effect effects/fill
properties:
 - en
required:
 - ty
 - ef

effects/custom-effect effects/group
required:
 - ty
 - ef

effect-values/layer effects/layer
required:
 - ty

effect-values/point effects/point
required:
 - ty

effects/pro-levels-effect effects/proLevels
properties:
 - en
required:
 - ty
 - ef

effect-values/slider effects/slider
required:
 - ty

effects/stroke-effect effects/stroke
properties:
 - en
required:
 - ty
 - ef

effects/tint-effect effects/tint
properties:
 - en
required:
 - ty
 - ef

effects/tritone-effect effects/tritone
properties:
 - en
required:
 - ty
 - ef

helpers/mask helpers/mask
properties:
 - mn
 - x

helpers/transform helpers/transform
properties:
 + py
 - or
 + pz
 - rz
 - ry
 + px
 - rx

layers/image-layer layers/image
properties:
 - tt
 - mn
 - mb
 - td
 - hd
required:
 - st

layers/null-layer layers/null
properties:
 - tt
 - mb
 - hasMask
 - masksProperties
 - mn
 - td
 - bm
 - hd
required:
 - st

layers/precomposition-layer layers/preComp
properties:
 - tt
 - h
 - mn
 - w
 - mb
 - td
 - hd
required:
 - st

layers/shape-layer layers/shape
properties:
 - tt
 - mn
 - mb
 - td
 - hd
required:
 - st

layers/solid-color-layer layers/solid
properties:
 - tt
 - mn
 - mb
 - td
 - hd
required:
 - st

layers/text-layer layers/text
properties:
 - tt
 - mn
 - mb
 - td
 - hd
required:
 - st

animated-properties/gradient-colors properties/gradient
properties:
 + a
 + ix

animated-properties/multi-dimensional properties/multiDimensional
properties:
 - a
required:
 - k

animated-properties/multi-dimensional properties/multiDimensionalKeyframed
properties:
 - a
required:
 - k

animated-properties/position properties/multiDimensionalSpatialKeyframed
properties:
 - a
 + to
 + ti
required:
 - k

animated-properties/keyframe properties/offsetKeyframe
properties:
 - h
required:
 - t
 - s

animated-properties/position-keyframe properties/offsetSpatialKeyframe
properties:
 - h
 - to
 - ti
required:
 - t
 - s

animated-properties/shape-property properties/shapeKeyframed
properties:
 - a

animated-properties/shape-keyframe properties/shapePropKeyframe
properties:
 - h

animated-properties/value properties/value
properties:
 - a
required:
 - k

shapes/ellipse shapes/ellipse
properties:
 - cix
 - bm
 - hd

shapes/fill shapes/fill
properties:
 - cix
 - r
 - bm
 - hd

shapes/gradient-fill shapes/gFill
properties:
 - cix
 - r
 - bm
 - hd
required:
 + t
 + h
 - g
 + a

shapes/gradient-stroke shapes/gStroke
properties:
 - cix
 - d
 - ml2
 - bm
 - hd
required:
 + t
 + h
 - g
 + a
 - w

shapes/merge shapes/merge
properties:
 - cix
 - bm
 - hd
required:
 - ty

shapes/rectangle shapes/rect
properties:
 - cix
 - bm
 - hd

shapes/repeater shapes/repeater
properties:
 - cix
 - bm
 - hd
required:
 + o

shapes/rounded-corners shapes/round
properties:
 - cix
 - bm
 - hd

shapes/path shapes/shape
properties:
 - cix
 - bm
 - hd
 - ind

shapes/polystar shapes/star
properties:
 - cix
 - bm
 - hd

shapes/stroke shapes/stroke
properties:
 - cix
 - d
 - ml2
 - bm
 - hd

shapes/transform shapes/transform
properties:
 - cix
 - or
 - rz
 - mn
 - ry
 - rx
 - bm
 - hd
required:
 - ty

shapes/trim shapes/trim
properties:
 - cix
 - bm
 - hd
 - m

assets/image sources/image
properties:
 - e
required:
 - id

assets/precomposition sources/precomp
properties:
 - fr
 - nm
required:
 - id

text/text-document layers/text
properties:
 - sz
required:
 + lh
 + tr
 + j

text/text-data-keyframe layers/text
required:
 - s

text/text-data layers/text
required:
 - k

text/text-animator-data layers/text
properties:
 - p
 - m
 - a

Files
 - constants/gradient-type
 - constants/star-type
 - constants/trim-multiple-shapes
 - constants/stroke-dash-type
 - text/text-more-options
 - constants/font-path-origin
 - text/text-animator-data-property
 - effects/drop-shadow-effect
 - shapes/pucker-bloat
 - effects/paint-over-transparent-effect
 - effects/mesh-warp-effect
 - constants/fill-rule
 - animated-properties/split-vector
 - effects/radial-wipe-effect
 + effects/customValue
 - shapes/zig-zag
 - effect-values/ignored
 - constants/matte-mode
 - text/font
 - constants/shape-direction
 - animated-properties/keyframe-bezier-handle
 - layers/audio-settings
 - layers/visual-layer
 - effects/gaussian-blur-effect
 - layers/audio-layer
 - shapes/twist
 - effects/matte3-effect
 - effects/displacement-map-effect
 - shapes/stroke-dash
 - animation/motion-blur
 - effects/spherize-effect
 - helpers/marker
 - assets/sound
 - constants/mask-mode
 - text/text-selector
 + effects/index
 - animation/metadata
 - text/masked-path
 - shapes/offset-path
 - shapes/repeater-transform
 - effects/puppet-effect
 - effects/wavy-effect
 - text/text-selector-property