Search UI Handover

Some Background

  • search-platform
  • search-platform-orchestration
  • search-ui

Getting started as a consumer

  • Oracle component exchange
  • Presentation config
  • oj-acx-search-view

Customisation

  • Props
  • Slot
  • Dynamic Slot
  • Hook methods

Development

  • Project structure
  • Key components & abstractions
  • States and interaction between components
  • Development conventions 
  • Create a new component
  • Release process

Project structure

Key abstractions

  • API client
  • Data Provider
  • Preference storage

Key components

  • Search View
  • Search Box
  • Search Result

States and interaction between components

Development conventions 

  • Which place to hold state? 
    • Shared state
    • Inner state
  • Component types:
    • Public
    • Private
  • Grouped props
  • Type definitions
    • Component Props
    • API Contract
    • Other
  • Which jetpack the new component should be added to?

Steps to create a new component

Release process

Other things worth to consider in future

  • Release note
  • FunctionComponet + hooks
  • State management framework (i.e: redux)? 
  • New private component feature provided by ojet?
  • Publish storybook to somewhere

Search UI Handover

By Alex Li

Search UI Handover

  • 146