• Skip to main navigation
  • Skip to main content

Help Center

Menu

Main navigation menu

  • Home
Documentation
  • DXP Platform
  • Squiz DXP
  • DXP APIs
  • DXP Releases

  • DXP Capabilities
  • Advanced Forms
  • Component Service
  • Content Management
  • Customer Data Platform
  • Data Services
  • Integrations
  • Optimization
  • Page Builder
  • Search

  • Legacy Products
  • Funnelback 15.24
  • Matrix 5
  • Workplace
Resources
  • Integration Library
  • Marketplace
  • Academy
  • My Squiz
  • Feedback

Component Service

    • Home
    • Getting started
      • About this service
      • Use cases and usage guidelines
      • File structure
      • manifest.json reference
      • DXP Component Library
    • Best practices
      • Inline editing
      • JavaScript and iFrame
    • Input field types
      • Array
      • Boolean
      • FormattedText
      • Integer
      • Null
      • Number
      • Object
      • SquizImage
      • SquizLink
      • String
    • Preview components
      • Preview configuration
      • Preview input data files
      • Preview HTML files
      • Test a specific preview
    • Environment variables
      • Add environment variable configuration to your manifest.json file
      • Use environment variables in your component code
      • Set environment variables locally
      • Add environment variables to a component set
    • Inline editing
    • Use static files with your component
      • Use external static files with your component
      • Include static files in your component
      • Reuse static files across your self-contained components
    • Resource Browser
      • Select resources through the component editing UI
      • Select resources through the rich text editor
      • Configure source nodes available to editors
      • Why are resources not appearing in the resource browser?
    • Component utilities
      • Context object
        • Context asset ID
        • Context URL
      • Functions object
        • Resolve URI
        • Resolve Matrix Asset ID
        • Resolve Matrix Asset URL
      • The Environment Object
    • Tutorials
      • Build and test your first component
        • Create component package file structure
        • Semantic Versioning and Component Services
        • Add a JavaScript function to render your component
        • Add code to your manifest file
        • Set up your local preview
        • Test using the local development server
        • Test using the local development user interface
      • Configure Content Management to use the Component Service
        • Configuration considerations
        • Communications overview
        • Set up a Content API token in Squiz Content Management Service
        • Set up Squiz Content Management Service API Identifiers in the DXP Console
        • Add your API Identifier to your Site asset
      • Deploy and use your component in Squiz DXP
        • Deploy your component to the DXP
        • Add the component to a component set
        • Add a component set to a site
        • Add your component to a Squiz Content Management Service page
      • Implement static files in the component lifecycle
        • Configure static files in the manifest.json file
        • Reference static files inside your component JavaScript code
        • Reference static files in Component preview
        • Reference static files in your site template
      • Components at Edge
        • Make changes to manifest.json
        • Change entrypoint code
        • Remove static files
        • Change to component context
        • Use the Fetch API
        • Change development command
        • Enable deployment
      • Delete components
    • Release notes
      • 2024 release notes
      • 2023 release notes
Component Service latest
  • Component Service
    • latest
  • Component Service
  • Best practices

Component service best practices

This section identifies best practices refined by Squiz that you can apply to developing components with the Component Service.

  • Best practices for inline editing components

    Create a great content editor experience with these inline editing best practices.

  • Best practices for JavaScript and iFrame implementations inside components

    Guidelines for JavaScript and iFrame implementations inside components.

Squiz
  • Contact us
  • Terms of use
  • Privacy policy
© 2025 Squiz