Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/ORM-1501 #10

Merged
merged 2 commits into from
Jul 16, 2024
Merged

Feature/ORM-1501 #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef8195b
feat: implement themeConfig and colorScheme as attributes
g-francesca Jul 16, 2024
2cc3650
fix: fix searchbox story
g-francesca Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions apps/storybook/.storybook/preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
import { defineCustomElements } from 'ui-stencil/loader'
import 'ui-stencil/dist/orama-ui/orama-ui.css'
import { html } from 'lit-html'
import { DARK_THEME_BG, LIGTH_THEME_BG } from '../constants'

defineCustomElements()

const LIGTH_THEME_BG = '#fbfbfb'
const DARK_THEME_BG = '#050505'

const preview = {
decorators: [
(story, context) => {
Expand Down
2 changes: 2 additions & 0 deletions apps/storybook/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export const LIGTH_THEME_BG = '#fbfbfb'
export const DARK_THEME_BG = '#050505'
32 changes: 32 additions & 0 deletions apps/storybook/stories/search-box.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,51 @@
import { spread } from '@open-wc/lit-helpers'
import type { StoryObj, Meta } from '@storybook/web-components'
import type { Components } from 'ui-stencil'
import { html } from 'lit-html'
import { DARK_THEME_BG, LIGTH_THEME_BG } from '../constants'
type Story = StoryObj<Components.SearchBox>

const meta: Meta<Components.SearchBox> = {
title: 'Public/SearchBox',
component: 'search-box',
argTypes: {
colorScheme: {
options: ['light', 'dark', 'system'],
defaultValue: 'light',
control: { type: 'radio' },
},
},
}
export default meta

// const Template = ({ colorScheme, ...args }, context) => {
// // todo: I'd like to programatically update parameters background value of colorScheme changes and vice versa
// console.log('colorScheme', colorScheme)
// console.log('args', args.themeConfig)

// return html`
// <search-box ${spread(args)} color-scheme=${colorScheme}></search-box>
// `
// }

export const SearchBox: Story = {
// render: Template,
args: {
open: true,
facetProperty: 'category',
resultMap: {
description: 'title',
},
colorScheme: 'light',
themeConfig: {
colors: {
light: {
'--text-color-primary': 'purple',
},
dark: {
'--text-color-primary': 'pink',
},
},
},
},
}
6 changes: 3 additions & 3 deletions packages/ui-stencil-vue/lib/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ export const OramaChatUserMessage = /*@__PURE__*/ defineContainer<JSX.OramaChatU

export const OramaFacets = /*@__PURE__*/ defineContainer<JSX.OramaFacets>('orama-facets', undefined, [
'facets',
'onFacetClick',
'selectedFacet'
'selectedFacet',
'onFacetClick'
]);


Expand Down Expand Up @@ -85,7 +85,7 @@ export const OramaToggler = /*@__PURE__*/ defineContainer<JSX.OramaToggler>('ora

export const SearchBox = /*@__PURE__*/ defineContainer<JSX.SearchBox>('search-box', undefined, [
'themeConfig',
'color',
'colorScheme',
'facetProperty',
'open',
'resultMap'
Expand Down
10 changes: 6 additions & 4 deletions packages/ui-stencil/src/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ import { InputProps } from "./components/internal/orama-input/orama-input";
import { ResultMap, SearchResult, SearchResultBySection } from "./types/index";
import { SearchResultsProps } from "./components/internal/orama-search-results/orama-search-results";
import { TextProps } from "./components/internal/orama-text/orama-text";
import { TThemeOverrides } from "./config/theme";
export { ButtonProps } from "./components/internal/orama-button/orama-button";
export { TChatMessage } from "./context/chatContext";
export { Facet } from "./components/internal/orama-facets/orama-facets";
export { InputProps } from "./components/internal/orama-input/orama-input";
export { ResultMap, SearchResult, SearchResultBySection } from "./types/index";
export { SearchResultsProps } from "./components/internal/orama-search-results/orama-search-results";
export { TextProps } from "./components/internal/orama-text/orama-text";
export { TThemeOverrides } from "./config/theme";
export namespace Components {
interface OramaButton {
"as"?: ButtonProps['as'];
Expand Down Expand Up @@ -85,11 +87,11 @@ export namespace Components {
"performInitialAnimation": boolean;
}
interface SearchBox {
"color": 'dark' | 'light' | 'system';
"colorScheme": 'dark' | 'light' | 'system';
"facetProperty"?: string;
"open"?: boolean;
"resultMap"?: Partial<ResultMap>;
"themeConfig": { colors: { light: { primaryColor: string }; dark: { primaryColor: string } } };
"themeConfig": Partial<TThemeOverrides>;
}
interface SearchBoxToggler {
}
Expand Down Expand Up @@ -294,11 +296,11 @@ declare namespace LocalJSX {
"performInitialAnimation"?: boolean;
}
interface SearchBox {
"color"?: 'dark' | 'light' | 'system';
"colorScheme"?: 'dark' | 'light' | 'system';
"facetProperty"?: string;
"open"?: boolean;
"resultMap"?: Partial<ResultMap>;
"themeConfig"?: { colors: { light: { primaryColor: string }; dark: { primaryColor: string } } };
"themeConfig"?: Partial<TThemeOverrides>;
}
interface SearchBoxToggler {
}
Expand Down
2 changes: 1 addition & 1 deletion packages/ui-stencil/src/components/internal/orama-facets/orama-facets.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ export type Facet = { name: string; count: number }
*/
export class OramaFacets {
@Prop() facets: Facet[]
@Prop() onFacetClick: (facetName: string) => void
@Prop() selectedFacet: string
@Prop() onFacetClick: (facetName: string) => void

handleClick(facet: Facet) {
this.onFacetClick(facet.name)
Expand Down
14 changes: 7 additions & 7 deletions packages/ui-stencil/src/components/search-box/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

## Properties

| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | ----------- | ------------------------------------------------------------------------------------- | ----------- |
| `color` | `color` | | `"dark" \| "light" \| "system"` | `undefined` |
| `facetProperty` | `facet-property` | | `string` | `undefined` |
| `open` | `open` | | `boolean` | `false` |
| `resultMap` | -- | | `{ title?: string; description?: string; path?: string; section?: string; }` | `{}` |
| `themeConfig` | -- | | `{ colors: { light: { primaryColor: string; }; dark: { primaryColor: string; }; }; }` | `undefined` |
| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| `colorScheme` | `color-scheme` | | `"dark" \| "light" \| "system"` | `'light'` |
| `facetProperty` | `facet-property` | | `string` | `undefined` |
| `open` | `open` | | `boolean` | `false` |
| `resultMap` | -- | | `{ title?: string; description?: string; path?: string; section?: string; }` | `{}` |
| `themeConfig` | -- | | `{ typography?: DeepPartial<{ '--font-primary': string; }>; colors?: DeepPartial<{ light: { '--text-color-primary': string; '--text-color-secondary': string; '--text-color-teriary': string; '--text-color-inactive': string; '--background-color-primary': string; '--background-color-secondary': string; '--background-color-tertiary': string; '--background-color-fourth': string; '--border-color-primary': string; '--border-color-secondary': string; '--border-color-inactive': string; '--icon-color-primary': string; '--icon-color-secondary': string; '--icon-color-tertiary': string; '--icon-color-inactive': string; '--icon-color-accent': string; }; dark: { '--text-color-primary': string; '--text-color-secondary': string; '--text-color-teriary': string; '--text-color-inactive': string; '--background-color-primary': string; '--background-color-secondary': string; '--background-color-tertiary': string; '--background-color-fourth': string; '--border-color-primary': string; '--border-color-secondary': string; '--border-color-inactive': string; '--icon-color-primary': string; '--icon-color-secondary': string; '--icon-color-tertiary': string; '--icon-color-inactive': string; '--icon-color-accent': string; }; system: {}; }>; }` | `undefined` |


## Dependencies
Expand Down
63 changes: 60 additions & 3 deletions packages/ui-stencil/src/components/search-box/search-box.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import { Component, Host, Prop, Watch, h, Listen } from '@stencil/core'
import { Component, Host, Prop, Watch, h, Listen, Element, State } from '@stencil/core'
import { OramaClient } from '@oramacloud/client'
import { searchState } from '@/context/searchContext'
import { chatContext } from '@/context/chatContext'
import { globalContext } from '@/context/GlobalContext'
import { ChatService } from '@/services/ChatService'
import { SearchService } from '@/services/SearchService'
import type { TThemeOverrides } from '@/config/theme'
import type { ResultMap } from '@/types'

@Component({
Expand All @@ -13,12 +14,22 @@ import type { ResultMap } from '@/types'
shadow: true,
})
export class SearchBox {
@Prop() themeConfig: { colors: { light: { primaryColor: string }; dark: { primaryColor: string } } }
@Prop() color: 'dark' | 'light' | 'system'
@Element() el: HTMLElement

@Prop() themeConfig: Partial<TThemeOverrides>
@Prop() colorScheme: 'dark' | 'light' | 'system' = 'light'
@Prop() facetProperty?: string
@Prop() open? = false
@Prop() resultMap?: Partial<ResultMap> = {}

@State() systemScheme: 'light' | 'dark' = 'light'

@Watch('themeConfig')
@Watch('colorScheme')
watchHandler() {
this.updateTheme()
}

@Watch('open')
handleOpenChange(newValue: boolean) {
globalContext.open = newValue
Expand All @@ -35,6 +46,49 @@ export class SearchBox {
console.log('Item clicked', event.detail)
}

updateTheme() {
const scheme = this.colorScheme === 'system' ? this.systemScheme : this.colorScheme
const uiElement = document.querySelector('#orama-ui')

if (uiElement && scheme) {
uiElement.classList.remove('theme-light', 'theme-dark')
uiElement.classList.add(`theme-${scheme}`)
}

this.updateCssVariables(scheme)
}

updateCssVariables(scheme: 'light' | 'dark') {
const config = this.themeConfig
const root = document.querySelector('#orama-ui') as HTMLElement

if (root && config && scheme) {
if (config.colors?.[scheme]) {
for (const key of Object.keys(config.colors[scheme])) {
root.style.setProperty(`${key}`, config.colors[scheme][key])
}
}
if (config.typography) {
for (const key of Object.keys(config.typography)) {
root.style.setProperty(`${key}`, config.typography[key])
}
}
}
}

detectSystemColorScheme() {
const darkSchemeQuery = window.matchMedia('(prefers-color-scheme: dark)')

this.systemScheme = darkSchemeQuery.matches ? 'dark' : 'light'

darkSchemeQuery.addEventListener('change', (event) => {
this.systemScheme = event.matches ? 'dark' : 'light'
if (this.colorScheme === 'system') {
this.updateTheme()
}
})
}

componentWillLoad() {
globalContext.open = this.open

Expand All @@ -52,6 +106,9 @@ export class SearchBox {

searchState.searchService = new SearchService(oramaClient)
chatContext.chatService = new ChatService(oramaClient)

this.updateTheme()
this.detectSystemColorScheme()
}

render() {
Expand Down
13 changes: 6 additions & 7 deletions packages/ui-stencil/src/config/colors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ export const primitive = {
gray900: '#151515',
gray950: '#050505',
purple500: '#8152EE',
purple700: '#6A4BB2'
purple700: '#6A4BB2',
}

export const sassVariables = {}

const semantic = {
const semanticColors = {
light: {
// TODO: placheholder primitives to be replaced
'--text-color-primary': primitive.gray50,
Expand All @@ -40,7 +40,7 @@ const semantic = {
'--icon-color-secondary': primitive.gray200,
'--icon-color-tertiary': primitive.gray600,
'--icon-color-inactive': primitive.gray500,
'--icon-color-accent': primitive.purple500
'--icon-color-accent': primitive.purple500,
},
dark: {
'--text-color-primary': primitive.gray50,
Expand All @@ -61,10 +61,9 @@ const semantic = {
'--icon-color-secondary': primitive.gray200,
'--icon-color-tertiary': primitive.gray600,
'--icon-color-inactive': primitive.gray500,
// TODO: check the primitive to use for accent
'--icon-color-accent': primitive.purple500
'--icon-color-accent': primitive.purple500,
},
system: {}
system: {},
}

export default semantic
export default semanticColors
10 changes: 9 additions & 1 deletion packages/ui-stencil/src/config/theme.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@ import typography from './typography'

const theme = {
typography,
colors
colors,
}

type TTheme = typeof theme

type DeepPartial<T> = {
[P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P]
}

export type TThemeOverrides = DeepPartial<TTheme>

export default theme
Loading