Skip to content

New icon for API

Purpose

Create a new icon to represent an API from the request in gitlab#118440 (closed).

Concept

Often an API is represented as a set of gears or an electrical plug. The gears approach seems more appropriate for GitLab. Given the 16px grid, the details are minimal.

api_1.svg

Checklists

Complete all items in both checklists before closing the issue. All items are the responsibility of the author, unless otherwise noted.

Design

  1. Duplicate the Icon template and move the copy to your Drafts folder in Figma. Update the file name and cover thumbnail with relevant issue information.
  2. Share your draft file with a FE/UX Foundation designer to review, and make sure they have view permissions in Figma. If they have the capacity, they should assign themselves to this issue. If not, try pinging another Foundations designer.
  3. Reviewer: Review the icon in the author’s draft file. Add design-specific comments in Figma to maintain context. Add general comments to this issue, including your approval status. Once approved, assign to a Figma maintainer for final review.
  4. Maintainer: Add the icon to the Pajamas UI Kit file, convert it to a component, and view it in the Assets panel to ensure it aligns with what’s outlined in the document and asset library structure documentation.
  5. Maintainer: Publish the library changes along with a clear message about the update.
  6. Author: Move your draft file to the Component archive Figma project.

Library addition

  1. Create a new merge request (MR) from this issue.
  2. Checkout the new branch locally.
  3. Export the icon component from the Pajamas UI Kit (in Figma) to the /sprite_icons folder in your local instance of the repo. The file name should be lowercase, and use hyphens as a separator between terms.
  4. Open the SVG you just exported in your code editor and remove fill="none" from the <svg> element.
  5. In a terminal window, run yarn run svg to add the icon to the library in the /dist folder.
  6. In a terminal window, run yarn run dev to preview the SVG library locally. Find the new icon and test it out by changing settings in the Icon configuration panel of the site. The icon should change color and size with no issues.
  7. After you’ve committed the changes and the pipeline passes, assign the MR to be reviewed and merged by a maintainer, and proceed with any changes.
  8. Add a read only (FYI) agenda item to the next UX weekly call to inform everyone of the new icon, linking to this issue.

If you run into any problems, ensure that all other steps in the project README have been followed.

Links / references

Edited by Jeremy Elder