Static Resources

This configuration allows you to define multiple staticresource paths to be resolved locally without having to explicitly map all files in your lwr.config.json file.

The configuration uses both a custom hook and module provider. These can be configured as follows:

lwr.config.json

"moduleProviders": [
  [
    "@lwc-garden/utils/resolvers/staticresources.ts",
    {
      "paths": ["force-app/main/default/staticresources"]
    }
  ]
]
"hooks": [
  "@lwc-garden/utils/hooks/staticresources.ts"
],
"globalData": {
  "garden": {
    "staticresources": {
      "paths": ["force-app/main/default/staticresources"]
    }
  }
}

Note

Both "paths" value should have the same values.

All files will be recursively available to be directly imported from within LWC via the lightning/platformResourceLoader imports, loadStyle() and loadScript().

Note

lightning/platformResourceLoader is automatically mocked as part of this package. Make sure you have set your module imports to include @lwc-garden/utils. Double check the documentation here.

Example usage:

lwc/myResourceTest/myResourceTest.js

import { LightningElement } from 'lwc'
import { loadStyle, loadScript } from 'lightning/platformResourceLoader'

import MY_RESOURCE_URL from '@salesforce/resourceUrl/myResource'

export default MyResourceTest extends LightningElement {
  isFirstRender = true

  async renderedCallback() {
    if (this.isFirstRender) {
      this.isFirstRender = false

      try {
        await Promise.all([
          loadScript(this, `${MY_RESOURCE_URL}/script.js`),
          loadStyle(this, `${MY_RESOURCE_URL}/style.css`)
        ])
        // successfully loaded - run logic here as required
      } catch (error) {
        console.error(`Error loading static resource from folder ${MY_RESOURCE_URL} `, error)
        // TODO: handle load error
      }
    }
  }
}