# Global configuration

Mini Program root directory app.json The file is used for global configuration of the WeChat Mini Program. The file content is a JSON Object has the following properties

# Configuration item

# entryPagePath

Specify the default start path (home page) of the Mini Program, common scenario is from the WeChat chat list page drop-down start, Mini Program list start. If not, the default is pages The first item in the list. Page path parameters are not supported.

{
  "entryPagePath": "pages/index/index"
}

# pages

That specifies which pages the Mini Program consists of, with each item corresponding to a page Path (including file name) Information. Filename does not need to write file suffix, framework will automatically find the corresponding location .json, .js, .wxml, .wxss Four files for processing.

Not specified entryPagePath The first item in the array represents the initial page (home page) of the Mini Program.

Mini Program Added/Reduce pages, all need to be on pages Array to modify.

If the development directory is:

 app.js
 app.json
 app.wxss
 pages
    index
       index.wxml
       index.js
       index.json
       index.wxss
    logs
        logs.wxml
        logs.js
 utils

You need to app.json Middle write

{
  "pages": ["pages/index/index", "pages/logs/logs"]
}

# window

Used to set Mini Program status bar, navigation bar, title, window background color.

• notes 1: Hex Color (hex color value), as in "#ff00ff"
• notes 2: AboutnavigationStyle
  • iOS/Android client 7.0.0 The following version,navigationStyle Only in app.json In effect.
  • iOS/Android client 6.7.2 Version starts,navigationStyle: custom Yes web-view Invalid component
  • open custom After the lower version of the client needs to do a good job of compatibility. Developer Tools Base Library Version Cut to 1.7.0 (does not represent the lowest version, only for debugging purposes) can easily cut to the old vision
  • Windows client 3.0 And above versions, in order to provide users with more consistent desktop software experience, unified the Mini Program window navigation bar,navigationStyle: custom No longer valid

Such as:

{
  "window": {
    "navigationBarBackgroundColor": "#ffffff",
    "navigationBarTextStyle": "black",
    "navigationBarTitleText": "WeChat interface function demonstration,"
    "backgroundColor": "#eeeeee",
    "backgroundTextStyle": "light"
  }
}

# tabBar

If the Mini Program is more than one tab Application (the bottom or top of the client window has tab Column to switch pages), you can click through the tabBar Configuration item designation tab Column performance, and tab The corresponding page to display when toggling.

among list Take an array,Only minimal configuration 2 Most 5 individual tab。 tab Sorted in the order of the array, each item is an object with the following property values

# networkTimeout

The timeout, in milliseconds, for each type of network request.

# debug

Can be turned on in the developer tools debug Mode, in the developer tools console panel, debugging information to info Is given in the form of Page Registration, page routing, data update, event triggering, etc. Can help developers quickly locate some common problems.

# functionalPages

Start from base library version 2.1.0. Please remaining backward compatible.

The plug-in owner Mini Program needs to set this item to enablePlugin function page。

# subpackages

WeChat Client 6.6.0 Base library 1.7.3 And above version support

EnableSubcontract loading, declare the project sub-packageing structure.

Written subPackages Also support.

# workers

Start from base library version 1.9.90. Please remaining backward compatible.

Use Worker When working with multithreaded tasks, setting the Worker Directory for code placement

# requiredBackgroundModes

WeChat Client 6.7.2 And above version support

Declare the ability to run in the background, type array. The following projects are currently supported:

• audio: Background Music Play
• location: Background positioning

Such as:

{
  "pages": ["pages/index/index"],
  "requiredBackgroundModes": ["audio", "location"]
}

Note: Here declared the background running interface, the development version and experience version can be directly effective, the official version also needs to pass the audit.

# plugins

Start from base library version 1.9.6. Please remaining backward compatible.

Declare that the Mini Program needs to useplug-in。

# preloadRule

Start from base library version 2.3.0. Please remaining backward compatible.

statementSubcontract pre-download.

# resizable

Start from base library version 2.3.0. Please remaining backward compatible.

in iPad Running on the Mini Program can set supportScreen Rotation。

in PC Run on the Mini Program, the user can drag the window size according to any proportion, you can also maximize the window in the Mini Program menu

# usingComponents

Developer tools 1.02.1810190 And above version support

The custom components declared here are treated as global custom components and can be used directly in pages within the Mini Program or in custom components without further declaration.

# permission

WeChat Client 7.0.0 And above version support

Mini ProgramInterface Permissions Related settings. Field type is Object, structured as:

PermissionObject structure

Such as:

{
  "pages": ["pages/index/index"],
  "permission": {
    "scope.userLocation": {
      "desc": "Your location information will be used to display the effects of the Mini Program location interface." // Continuous Background Positioning for Freeway Driving
    }
  }
}

# sitemapLocation

Specify sitemap.json LocationDefault is sitemap.json That is, app.json Of the name in the sibling directory sitemap.json file

# Configuration sample

{
  "pages": ["pages/index/index", "pages/logs/index"],
  "window": {
    "navigationBarTitleText": "Demo"
  },
  "tabBar": {
    "list": [
      {
        "pagePath": "pages/index/index",
        "text": "Home Page"
      },
      {
        "pagePath": "pages/logs/logs",
        "text": "Log."
      }
    ]
  },
  "networkTimeout": {
    "request": 10000,
    "downloadFile": 10000
  },
  "debug": true,
}

# style

Start from base library version 2.8.0. Please remaining backward compatible.

WeChat Client 7.0 Start, UI The interface has undergone a major overhaul. The Mini Program also has a style upgrade for the underlying component. apagejson Configuration in "style": "v2"Can indicate that a new version of the component style is enabled.

The components involved in this change are button icon radio checkbox switch sliderYou can go to the Mini Programs sample to experience.

# useExtendedLib

Start from base library version 2.2.1. Please remaining backward compatible.

Latest nightly Version of the developer tool to start support, while the base library from support npm Version (2.2.1)

Specifies the extension library to be referenced. The following projects are currently supported:

• kbone: Multiterminal development framework
• weui: WeUI Component library

When specified, is equivalent to introducing the latest version of the corresponding extension library npm Package, but also does not occupy the Mini Programs package volume. The rc tool version supports sub-packageing references. Usage is as follows:

{
  "useExtendedLib": {
    "kbone": true,
    "weui": true
  }
}

# entranceDeclare

WeChat Client 7.0.9 And above version support, iOS Temporary support

Chat location message with a taxi class Mini Program to open,Details Reference。

"entranceDeclare": {
    "locationMessage": {
        "path": "pages/index/index",
        "query": "foo=bar"
    }
}

# darkmode

Developer tools 1.03.2004271 And above version support, base library 2.11.0 And above version support

WeChat iOS client 7.0.12 Version, Android client 7.0.13 Version Official Support Dark Mode can be configured by"darkmode": trueIndicates that the current Mini Program is adaptable DarkMode, all basic components will display different default styles according to the system theme, navigation bar and tab bar It also switches automatically depending on the developer's configuration.

Once configured, follow the[DarkMode Adaptation guidelines](../../framework/ability/Darkmode. md does the adaptation work itself beyond the base style.

{
  "darkmode": true
}

# themeLocation

custom theme.json Path, when configured'darkmode': trueThe current configuration file is required.

{
  "themeLocation": "/path/to/theme.json"
}

# lazyCodeLoading

Currently only supported values requiredComponentsRepresents the opening of the Mini ProgramOn-demand injection feature.

{
  "lazyCodeLoading": "requiredComponents"
}

# singlePage

Base library 2.11.3 And above, currentlyShare to your friends (Beta) Open later and enter single page mode

Single-page mode correlation configuration