Skip to content
Snippets Groups Projects
readme.md 3.66 KiB
Newer Older
  • Learn to ignore specific revisions
  • # site-header
    
    <!-- Auto Generated Below -->
    
    ## Properties
    
    
    | Property               | Attribute                 | Description | Type                                                                                               | Default            |
    | ---------------------- | ------------------------- | ----------- | -------------------------------------------------------------------------------------------------- | ------------------ |
    | `dataDesktopLinks`     | `data-desktop-links`      |             | `DesktopLinks[] \| string`                                                                         | `undefined`        |
    | `dataMenuDonate`       | `data-menu-donate`        |             | `string`                                                                                           | `undefined`        |
    | `dataMenuLanguage`     | `data-menu-language`      |             | `string`                                                                                           | `undefined`        |
    
    | `dataSearchTools`      | `data-search-tools`       |             | `DesktopLinks[] \| string`                                                                         | `undefined`        |
    
    | `dataSiteHeaderLabels` | `data-site-header-labels` |             | `string`                                                                                           | `undefined`        |
    
    | `dataSiteSearchLabels` | `data-site-search-labels` |             | `string`                                                                                           | `undefined`        |
    
    | `logoLabel`            | `logo-label`              |             | `string`                                                                                           | `undefined`        |
    | `logoUrl`              | `logo-url`                |             | `string`                                                                                           | `undefined`        |
    
    | `menuLabel`            | `menu-label`              |             | `string`                                                                                           | `'Menu'`           |
    
    | `menuLabelClose`       | `menu-label-close`        |             | `string`                                                                                           | `undefined`        |
    | `menuLabelOpen`        | `menu-label-open`         |             | `string`                                                                                           | `undefined`        |
    | `menuType`             | `menu-type`               |             | `MenuType.desktop \| MenuType.mobile \| MenuType.sidenav \| MenuType.sidepanel \| MenuType.tablet` | `MenuType.default` |
    
    druid's avatar
    druid committed
    | Event               | Description | Type               |
    | ------------------- | ----------- | ------------------ |
    | `headerScrollUp`    |             | `CustomEvent<any>` |
    | `menuMobileToggled` |             | `CustomEvent<any>` |
    
    ## Dependencies
    
    ### Depends on
    
    - [hy-site-logo](site-logo)
    
    - [hy-desktop-menu-links](hy-desktop-menu-links)
    
    - [hy-menu-language](../navigation/menu-language)
    
    - [hy-site-search](site-search)
    - [hy-icon](../icon)
    
    ### Graph
    
    ```mermaid
    graph TD;
      hy-site-header --> hy-site-logo
    
      hy-site-header --> hy-desktop-menu-links
    
      hy-site-header --> hy-menu-language
    
      hy-site-header --> hy-site-search
      hy-site-header --> hy-icon
      hy-site-logo --> hy-icon
    
      hy-desktop-menu-links --> hy-icon
    
      hy-menu-language --> hy-menu-language-item
      hy-menu-language --> hy-icon
    
      hy-site-search --> hy-icon
    
    druid's avatar
    druid committed
      hy-site-search --> hy-search-field
      hy-search-field --> hy-icon
    
      style hy-site-header fill:#f9f,stroke:#333,stroke-width:4px
    ```
    
    ---
    
    Helsinki University Design System