Version

Each design system consists of one or more versions and you are always targeting one version when you run a specific exporter. The version object gives you access to meta-information about a specific version, such as its semantic label, name, or even full release notes.

Example Design System Version Payload

This is what the design system version payload looks like:


                                        
                                        
                                        {
                                          "id": string
                                          "designSystemId": string
                                        
                                          "name": string
                                          "description": string
                                        
                                          "version": string
                                          "changeLog": string | null
                                          "isReadOnly": boolean
                                        }
                                        
                                        

Associated functions

You can use the following functions to retrieve information about design system versions:

  • @ds.currentDesignSystemVersion
  • @ds.allDesignSystemVersions