@jobber/components-native

🔱 Jobber Atlantis Components - Mobile 📱

Atlantis is a component library designed and maintained by Jobber.

This package contains the base set of React components for Atlantis.

Installation

To install this package into your project with npm run:

npm install @jobber/components-native
# iOS Linking
cd ios
pod install

Usage

Import and render an Atlantis component:

import React from "react";
import { Icon } from "@jobber/components-native";

export function MyComponent() {
  return <Icon />;
}

Setting up with Jest

In order to make @jobber/components-native work with Jest, you may need to make Jest transpile the package by adding "/node_modules/@jobber/components-native" to transformIgnorePatterns in you Jest config.

transformIgnorePatterns: [
  "node_modules/@jobber/components-native",
],

Also update the Jest config as to include the jestSetup.js

setupFiles: [
    ...
    "./node_modules/@jobber/components-native/jestSetup.js",
    ...
  ],

You will also need to create a mock for the Form component

jest.mock("./dist/src/Form", () => {
  const { Form, AtlantisFormContext, ...Actual } =
    jest.requireActual("./dist/src/Form");
  const useConfirmBeforeBack = jest.fn(() => jest.fn());
  const useInternalFormLocalCache = jest.fn(() => ({
    setLocalCache: jest.fn(),
    removeLocalCache: jest.fn(),
  }));
  // Or
  const useConfirmBeforeBack = require("<path-to-your>/useConfirmBeforeBackHook");
  const useInternalFormLocalCache = require("<path-to-your>/useInternalFormLocalCacheHook");
  return {
    ...Actual,
    AtlantisFormContext: AtlantisFormContext,
    Form: ({ children, ...props }) => {
      return (
        <AtlantisFormContext.Provider
          value={{ useConfirmBeforeBack, useInternalFormLocalCache }}
        >
          <Form {...props}>{children}</Form>
        </AtlantisFormContext.Provider>
      );
    },
  };
});

Further Reading

More information on Atlantis can be found at https://atlantis.getjobber.com.