Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home Orlando Now Platform Capabilities Now Platform capabilities Agent Workspace Developing components for Workspace Develop a component

    Develop a component

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Develop a component

    Add your component code and test it using a local development server.

    Before you begin

    • Set up your environment
    • Set up your project

    About this task

    For a tutorial on developing a counter component, visit the Developer Site.

    Procedure

    1. In your project directory, navigate to src/<component-name>/index.js. This is the primary code file for a component.
    2. Add your component code.
      import {createCustomElement} from '@servicenow/ui-core';
      import snabbdom from '@servicenow/ui-renderer-snabbdom';
      import styles from './styles.scss';
      
      const view = (state, {updateState}) => {
      	return (
      		<div>Hello World!</div>
      	);
      };
      
      createCustomElement('hello-world', {
      	renderer: {type: snabbdom},
      	view,
      	styles
      });
    3. Optionally add inner components.
      An inner component is a component included in another component. For example, a card component might include a separate button component. The button component becomes an inner component that you must import, install, and define in the card component project.
      1. Install the inner component package by executing the install command using your system's command line tool:
        npm install @servicenow/<now-inner-button> 
      2. Add an import statement to the top of your index.js file:
        import '@servicenow/<now-inner-button>’;
      3. Use the inner component in your index.js file:
        <now-inner-button label="Click Me" />
      4. List the inner component in the components.[component-name].innerComponents array in the now-ui.json configuration file.
        {
          "components": {
            "now-chart-timeseries": {
              "innerComponents": [
                "now-inner-button"
              ],
    4. Run the development server command to view your component in a test browser.
      now-cli develop

      Pass in values for these parameters.

      Name Description
      entry Path to the test module in your component project.

      Default: example/index.js.

      open Opens the default browser and navigates to the test page.

      Default: false.

      port Port where the development server runs.

      Default: 8081.

      host Host address to use if you want your local development server to be accessible externally by others. Typically set to 0.0.0.0
      now-cli develop --entry example/hello.js --open --port 3000

    What to do next

    Deploy a component to an instance.
    Related concepts
    • Developing components for Workspace

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Develop a component

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Develop a component

      Add your component code and test it using a local development server.

      Before you begin

      • Set up your environment
      • Set up your project

      About this task

      For a tutorial on developing a counter component, visit the Developer Site.

      Procedure

      1. In your project directory, navigate to src/<component-name>/index.js. This is the primary code file for a component.
      2. Add your component code.
        import {createCustomElement} from '@servicenow/ui-core';
        import snabbdom from '@servicenow/ui-renderer-snabbdom';
        import styles from './styles.scss';
        
        const view = (state, {updateState}) => {
        	return (
        		<div>Hello World!</div>
        	);
        };
        
        createCustomElement('hello-world', {
        	renderer: {type: snabbdom},
        	view,
        	styles
        });
      3. Optionally add inner components.
        An inner component is a component included in another component. For example, a card component might include a separate button component. The button component becomes an inner component that you must import, install, and define in the card component project.
        1. Install the inner component package by executing the install command using your system's command line tool:
          npm install @servicenow/<now-inner-button> 
        2. Add an import statement to the top of your index.js file:
          import '@servicenow/<now-inner-button>’;
        3. Use the inner component in your index.js file:
          <now-inner-button label="Click Me" />
        4. List the inner component in the components.[component-name].innerComponents array in the now-ui.json configuration file.
          {
            "components": {
              "now-chart-timeseries": {
                "innerComponents": [
                  "now-inner-button"
                ],
      4. Run the development server command to view your component in a test browser.
        now-cli develop

        Pass in values for these parameters.

        Name Description
        entry Path to the test module in your component project.

        Default: example/index.js.

        open Opens the default browser and navigates to the test page.

        Default: false.

        port Port where the development server runs.

        Default: 8081.

        host Host address to use if you want your local development server to be accessible externally by others. Typically set to 0.0.0.0
        now-cli develop --entry example/hello.js --open --port 3000

      What to do next

      Deploy a component to an instance.
      Related concepts
      • Developing components for Workspace

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login