@ebrains/components 2.3.0 → 2.4.0

package/dist/components/p-ad0519b7.entry.js

@@ -1 +0,0 @@
-import{h as e,r as n}from"./p-271c61ff.js";const t=()=>e("div",{class:"static-content container"},e("h2",null,"Load the module"),e("p",null,"Integrating the EBRAINS UI Components to a project ",e("b",null,"with or without a JavaScript framework")," is straight forward. If you’re working on a simple HTML page, you can start using the components immediately by adding the tags below to the ",e("code",null,"head"),"."),e("eds-code-block",{code:"<script type='module'>\n  import { defineCustomElements } from 'https://unpkg.com/@ebrains/components@latest/loader/index.js'; \n  // Define custom elements\n  defineCustomElements(window);\n<\/script>",language:"javascript","copy-label":"Copy Code"}),e("p",null,"This snippet is part of the Stencil component loader system. Under the hood, it does the following:"),e("eds-steps",{steps:[{title:"Import the Loader Module",content:"The script imports the defineCustomElements function from the Stencil-generated loader module hosted at a CDN. This module contains the registration logic for all your custom components."},{title:"Register Custom Elements",content:"Calling defineCustomElements(window) loops through the available components and registers each one with the browser using customElements.define(). This makes your custom elements available in the DOM."},{title:"Lazy Loading in Action",content:"Although all components are registered on startup, their implementation code is lazy-loaded. This means a component's code is only fetched when it is first used, optimizing the initial load time."},{title:"Optimized Performance",content:"By registering components early and lazy-loading their implementations, the script helps maintain a fast startup while ensuring that all custom elements are ready for use when needed."}]}),e("p",null,"Once included, components can be used in your markup like any other regular HTML elements:"),e("eds-code-block",{code:'<eds-button label="my bytton" intent="primary"></eds-button>',language:"html","copy-label":"Copy Code"}),e("h2",null,"Load the variables and styles"),e("p",null,"To directly use only the produced variables (colors, breakpoints, typography) add the tag below to the"," ",e("code",null,"head"),". This approach is recommended when you’re working solely with the web components and want minimal integration. That said, the components are configured to require only these CSS variables and nothing more."),e("eds-code-block",{code:'<link rel="stylesheet" href="https://unpkg.com/@ebrains/assets@latest/styles/vars.css"/>',language:"css","copy-label":"Copy Code"}),e("p",null,"To directly use the produced css framework with a few predefined custom utility classes, add the tag below to the"," ",e("code",null,"head"),". Use this when you want quick access to ready-made utilities for building your own components or applications and you do not wish to dive deep to css configurations."),e("eds-code-block",{code:'<link rel="stylesheet" href="https://unpkg.com/@ebrains/assets@latest/styles/output.css"/>',language:"css","copy-label":"Copy Code"}),e("p",null,"Note that, loading either the variables or the predefined CSS framework above,"," ",e("b",null,"automatically loads the fonts so you can skip loading them separately"),".")),s=()=>e("div",null,e("p",null,"Before proceeding, ensure that Node.js is installed on your machine—you can download the latest version from the official website. If your project doesn’t already use npm and you plan to integrate EBRAINS Components, you'll need to create a package.json file by running npm init and following the on-screen instructions."),e("div",{class:"my-8"},e("eds-code-block",{code:"npm install @ebrains/components",language:"html","copy-label":"Copy Code"})),e("div",{class:"my-8"},e("eds-code-block",{code:"npm install @ebrains/react",language:"html","copy-label":"Copy Code"})),e("div",{class:"my-8"},e("eds-code-block",{code:"npm install @ebrains/vue",language:"html","copy-label":"Copy Code"})),e("div",{class:"my-8"},e("eds-code-block",{code:"npm install @ebrains/angular",language:"html","copy-label":"Copy Code"})),e("div",{class:"my-8"},e("eds-code-block",{code:"npm install @ebrains/assets",language:"html","copy-label":"Copy Code"})),e("div",{class:"my-8"},e("eds-code-block",{code:"npm install @ebrains/svgs",language:"html","copy-label":"Copy Code"}))),o=()=>e("div",null,e("h2",null,"React Wrappers"),e("p",null,"To use the EBRAINS web components in a React Application, simple install the package below and check out the examples"),e("eds-code-block",{code:"npm install @ebrains/react",language:"javascript","copy-label":"Copy Code"}),e("eds-section-core",{"section-title":"Example React App","heading-level":"h3"},e("p",null,"This code displays a Stencil-based splash screen that stays visible until an initialization promise resolves (or errors), then hides itself and reveals the main React app content."),e("eds-code-block",{code:"\nimport React, { useMemo, useState } from 'react';\nimport {\n  EdsHeader,\n  EdsSplashScreen,\n  EdsMatomoNotice,\n  EdsSteps\n} from '@ebrains/react';\nimport './app.css';\n\n// simulate 2s\nfunction fakeInit(): Promise<void> {\n  return new Promise(resolve => setTimeout(resolve, 2000));\n}\n\nexport function App() {\n  // 1) create init promise\n  const initPromise = useMemo(() => fakeInit(), []);\n\n  // 2) is splash still visible\n  const [splashVisible, setSplashVisible] = useState(true);\n  const [initError, setInitError] = useState<string | null>(null);\n\n  // 3) show the UI after the splash has hidden\n  const showApp = !splashVisible && !initError;\n\n  return (\n    <div>\n      {splashVisible && (\n        <EdsSplashScreen\n          inverse={false}\n          initPromise={initPromise}\n          onSplash={(e: CustomEvent) => {\n            if (e.detail.type === 'hidden') {\n              setSplashVisible(false);\n            } else if (e.detail.type === 'error') {\n              setInitError(e.detail.message);\n              setSplashVisible(false);\n            }\n          }}\n        />\n      )}\n\n      {initError && (\n        <div className='error'>\n          Failed to initialize: {initError}\n        </div>\n      )}\n\n      {/* Show App only when ready */}\n      {showApp && (\n        <>\n          <EdsHeader></EdsHeader>\n          <EdsSteps\n            steps={[\n              {\n                title: 'Introduction',\n                content: 'Begin by familiarizing yourself with the overall process.'\n              },\n              {\n                title: 'Process Overview',\n                content: 'Review the detailed steps and understand the workflow.'\n              }\n            ]}\n            type='linear'\n          />\n\n          <EdsMatomoNotice />\n\n          <div id='root'></div>\n        </>\n      )}\n    </div>\n  );\n}\nexport default App;\n",language:"javascript","copy-label":"Copy Code"}))),a=()=>e("div",null,e("h2",null,"Vue Wrappers"),e("p",null,"To use the EBRAINS web components in a Vue Application, simple install the package below and check out the examples."),e("eds-code-block",{code:"npm install @ebrains/vue",language:"javascript","copy-label":"Copy Code"}),e("h2",null,"Passing Properties to Custom Elements Using the ",e("b",null,".prop")," Modifier in Vue Wrappers"),e("p",null,"When using Vue wrappers for Stencil components (or any custom elements), you might encounter issues with property names being altered due to HTML’s attribute handling. By default, Vue binds values as HTML attributes, and HTML attributes are case-insensitive. This means that camelCase property names can be transformed into lowercase strings, which can prevent your component from receiving the correct data."),e("h3",null,"How to Use the ",e("b",null,".prop")," Modifier"),e("p",null,"When using Vue wrappers, you can pass properties with the .prop modifier by adding it to your binding expression. Here’s an example of how to do it:"),e("div",{class:"my-8"},e("eds-alert",{message:"This may lead to issues because Vue binds these as attributes .",intent:"error"})),e("eds-code-block",{code:'<EdsAlert\n  message="This is a default informational alert."\n  intent="default"\n  :pressableLabel="Press Me"\n  :pressableUrl="https://ebrains.eu"\n></EdsAlert>',language:"javascript","copy-label":"Copy Code"}),e("div",{class:"my-8"},e("eds-alert",{message:"Use the .prop modifier to ensure properties are passed correctly.",intent:"default"})),e("eds-code-block",{code:'<EdsAlert\n  message="This is a default informational alert."\n  intent="default"\n  :pressableLabel.prop="Press Me"\n  :pressableUrl.prop="https://ebrains.eu"\n></EdsAlert>',language:"javascript","copy-label":"Copy Code"}),e("p",null,"Using the ",e("b",null,".prop")," modifier in Vue ensures that the data you pass to your custom elements is received as intended. It prevents Vue (and the browser) from transforming camelCase property names into lowercase attributes, thereby maintaining the correct data mapping in your Stencil components."),e("eds-section-core",{"section-title":"Example Vue App","heading-level":"h3"},e("eds-code-block",{code:'\n<template>\n  <div>\n    <EdsHeader></EdsHeader>\n    \x3c!-- render the splash until we manually hide it --\x3e\n    <EdsSplashScreen inverse="false" />\n\n    \x3c!-- then show main UI --\x3e\n    <div v-if="!splashVisible" class="container my-16">\n      <EdsSteps \n        :steps="JSON.stringify(stepsdata)"\n        type="linear"\n      />\n    </div>\n  </div>\n</template>\n\n<script>\nimport { EdsSplashScreen, EdsSteps, EdsHeader } from "@ebrains/vue";\n\nexport default {\n  name: "App",\n  components: { EdsHeader, EdsSplashScreen, EdsSteps },\n  data() {\n    return {\n      stepsdata: [\n        { title: "Introduction", content: "Begin by familiarizing yourself with the overall process." },\n        { title: "Process Overview", content: "Review the detailed steps and understand the workflow." }\n      ],\n      splashVisible: true\n    };\n  },\n  methods: {\n    delay(ms) {\n      return new Promise(resolve => setTimeout(resolve, ms));\n    },\n    async initialize() {\n      try {\n        // simulate your init work\n        await this.delay(2000);\n\n        // fire the built-in event that EdsSplashScreen listens for\n        window.dispatchEvent(new Event("hideSplash"));\n      } catch (e) {\n        console.error("Init error", e);\n        window.dispatchEvent(new Event("hideSplash"));\n      } finally {\n        // show the rest of the app\n        this.splashVisible = false;\n      }\n    }\n  },\n  mounted() {\n    this.initialize();\n  }\n};\n<\/script>\n',language:"javascript","copy-label":"Copy Code"}))),l=()=>e("div",null,e("h2",null,"Angular Wrappers"),e("p",null,"To use the EBRAINS web components in an Angular Application, simple install the package below and check out the examples. The Angular Stencil output type used for this package = `standalone`."),e("eds-code-block",{code:"npm install @ebrains/angular",language:"javascript","copy-label":"Copy Code"}),e("p",null,"Install the components dependency as this important for the angular package to work properly."),e("eds-code-block",{code:"npm install @ebrains/components",language:"javascript","copy-label":"Copy Code"}),e("p",null,"Define the custom elements"),e("eds-code-block",{code:"import { defineCustomElements } from '@ebrains/components/loader';\ndefineCustomElements();",language:"javascript","copy-label":"Copy Code"}),e("eds-section-core",{"section-title":"Example Angular App","heading-level":"h3"},e("eds-code-block",{code:'\n<div class="container">\n  <eds-breadcrumb\n    intent="tertiary"\n    items="[\n      { "label": "Home", "url": "#" },\n      { "label": "Products", "url": "#" },\n    ]">\n  </eds-breadcrumb>\n  <eds-footer></eds-footer>\n</div>',language:"javascript","copy-label":"Copy Code"}))),i=class{constructor(e){n(this,e),this.tabIndex=void 0}renderContent(){switch(this.tabIndex){case 0:return e(t,null);case 1:return e(s,null);case 2:return e(o,null);case 3:return e(a,null);case 4:return e(l,null);default:return e("p",null,"Content not available.")}}render(){return e("div",{key:"d5f1ea9d290addbfa2a4c21e815597871f6d7639",class:"container"},this.renderContent())}};export{i as components_section}