Init component

AB-xdev · lars-xdev · AB-xdev · commit 6374f7abfb20 · 2024-10-17T18:39:00.000+02:00
Co-Authored-By: Lars S. &lt;175799162+lars-xdev@users.noreply.github.com&gt;
diff --git a/assets/demo.avif b/assets/demo.avif
diff --git a/assets/demo.png b/assets/demo.png
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/MainView.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/MainView.java
@@ -0,0 +1,70 @@
+package software.xdev.vaadin.view;
+
+import java.util.Objects;
+
+import com.vaadin.flow.component.HasElement;
+import com.vaadin.flow.component.UI;
+import com.vaadin.flow.component.applayout.AppLayout;
+import com.vaadin.flow.component.applayout.DrawerToggle;
+import com.vaadin.flow.component.icon.VaadinIcon;
+import com.vaadin.flow.component.orderedlayout.HorizontalLayout;
+import com.vaadin.flow.component.orderedlayout.VerticalLayout;
+import com.vaadin.flow.component.sidenav.SideNav;
+import com.vaadin.flow.component.sidenav.SideNavItem;
+import com.vaadin.flow.router.PageTitle;
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.breadcrumbs.Breadcrumbs;
+import software.xdev.vaadin.view.cars.CarsView;
+import software.xdev.vaadin.view.cars.brand.AudiView;
+import software.xdev.vaadin.view.cars.brand.BMWView;
+import software.xdev.vaadin.view.cars.brand.PorscheView;
+
+
+@Route("")
+@PageTitle("Breadcrumb Demo")
+public class MainView extends AppLayout
+{
+	private static final String SIDE_NAV_I18N_PREFIX = "sidenav_";
+	
+	private final Breadcrumbs breadcrumbs = new Breadcrumbs();
+	
+	public MainView()
+	{
+		final SideNav sideNav = new SideNav();
+		sideNav.addItem(new SideNavItem(
+			this.getTranslation(SIDE_NAV_I18N_PREFIX + "home"),
+			"",
+			VaadinIcon.HOME_O.create()));
+		
+		final SideNavItem carsItem = new SideNavItem(
+			this.getTranslation(SIDE_NAV_I18N_PREFIX + "cars"),
+			CarsView.class,
+			VaadinIcon.CAR.create());
+		carsItem.addItem(new SideNavItem("Audi", AudiView.class));
+		carsItem.addItem(new SideNavItem("BMW", BMWView.class));
+		carsItem.addItem(new SideNavItem("Porsche", PorscheView.class));
+		
+		sideNav.addItem(Objects.requireNonNull(carsItem));
+		
+		this.setPrimarySection(Section.DRAWER);
+		
+		final VerticalLayout navWrapper = new VerticalLayout(sideNav);
+		sideNav.setWidthFull();
+		navWrapper.setSpacing(true);
+		this.addToDrawer(navWrapper);
+		
+		final HorizontalLayout vlHeader = new HorizontalLayout(new DrawerToggle(), this.breadcrumbs);
+		vlHeader.setSpacing(false);
+		this.addToNavbar(vlHeader);
+		
+		UI.getCurrent().getElement().setAttribute("theme", "dark");
+	}
+	
+	@Override
+	public void showRouterLayoutContent(final HasElement content)
+	{
+		super.showRouterLayoutContent(content);
+		this.breadcrumbs.updateFromCurrentPath();
+	}
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/AbstractCarView.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/AbstractCarView.java
@@ -0,0 +1,48 @@
+package software.xdev.vaadin.view.cars;
+
+import java.util.List;
+
+import com.vaadin.flow.component.orderedlayout.VerticalLayout;
+
+
+public abstract class AbstractCarView extends VerticalLayout
+{
+	protected static final String AUDI = "Audi";
+	protected static final String BMW = "BMW";
+	protected static final String PORSCHE = "Porsche";
+	
+	protected AbstractCarView()
+	{
+		final CarGrid carGrid = new CarGrid(this.getCars());
+		carGrid.setAllRowsVisible(true);
+		this.add(carGrid);
+	}
+	
+	protected abstract List<Car> getCars();
+	
+	protected static List<Car> getCarsByBrand(final String brand)
+	{
+		return getAllCars().stream()
+			.filter(c -> brand.equals(c.brand()))
+			.toList();
+	}
+	
+	@SuppressWarnings("checkstyle:MagicNumber")
+	protected static List<Car> getAllCars()
+	{
+		return List.of(
+			new Car(AUDI, "A4", 190),
+			new Car(AUDI, "A3", 150),
+			new Car(AUDI, "S4", 250),
+			new Car(AUDI, "Q5", 300),
+			new Car(BMW, "318i", 190),
+			new Car(BMW, "M4", 400),
+			new Car(BMW, "420d", 200),
+			new Car(BMW, "X5", 250),
+			new Car(PORSCHE, "Cayenne", 300),
+			new Car(PORSCHE, "911", 400),
+			new Car(PORSCHE, "Carrera", 400),
+			new Car(PORSCHE, "GT3RS", 600)
+		);
+	}
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/Car.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/Car.java
@@ -0,0 +1,5 @@
+package software.xdev.vaadin.view.cars;
+
+public record Car(String brand, String name, int hp)
+{
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/CarGrid.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/CarGrid.java
@@ -0,0 +1,19 @@
+package software.xdev.vaadin.view.cars;
+
+import java.util.List;
+
+import com.vaadin.flow.component.grid.Grid;
+
+
+public class CarGrid extends Grid<Car>
+{
+	private static final String I18N_PREFIX = "grid_";
+	
+	public CarGrid(final List<Car> cars)
+	{
+		this.setItems(cars);
+		this.addColumn(Car::brand).setHeader(this.getTranslation(I18N_PREFIX + "branch"));
+		this.addColumn(Car::name).setHeader(this.getTranslation(I18N_PREFIX + "type"));
+		this.addColumn(Car::hp).setHeader(this.getTranslation(I18N_PREFIX + "hp"));
+	}
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/CarsView.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/CarsView.java
@@ -0,0 +1,18 @@
+package software.xdev.vaadin.view.cars;
+
+import java.util.List;
+
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.view.MainView;
+
+
+@Route(value = "cars", layout = MainView.class)
+public class CarsView extends AbstractCarView
+{
+	@Override
+	protected List<Car> getCars()
+	{
+		return getAllCars();
+	}
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/brand/AudiView.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/brand/AudiView.java
@@ -0,0 +1,21 @@
+package software.xdev.vaadin.view.cars.brand;
+
+import java.util.List;
+
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.view.MainView;
+import software.xdev.vaadin.view.cars.AbstractCarView;
+import software.xdev.vaadin.view.cars.Car;
+
+
+@Route(value = "cars/audi", layout = MainView.class)
+public class AudiView extends AbstractCarView
+{
+	@Override
+	@SuppressWarnings("checkstyle:MagicNumber")
+	protected List<Car> getCars()
+	{
+		return getCarsByBrand(AUDI);
+	}
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/brand/BMWView.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/brand/BMWView.java
@@ -0,0 +1,21 @@
+package software.xdev.vaadin.view.cars.brand;
+
+import java.util.List;
+
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.view.MainView;
+import software.xdev.vaadin.view.cars.AbstractCarView;
+import software.xdev.vaadin.view.cars.Car;
+
+
+@Route(value = "cars/bmw", layout = MainView.class)
+public class BMWView extends AbstractCarView
+{
+	@Override
+	@SuppressWarnings("checkstyle:MagicNumber")
+	protected List<Car> getCars()
+	{
+		return getCarsByBrand(BMW);
+	}
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/brand/PorscheView.java b/vaadin-breadcrumbs-demo/src/main/java/software/xdev/vaadin/view/cars/brand/PorscheView.java
@@ -0,0 +1,21 @@
+package software.xdev.vaadin.view.cars.brand;
+
+import java.util.List;
+
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.view.MainView;
+import software.xdev.vaadin.view.cars.AbstractCarView;
+import software.xdev.vaadin.view.cars.Car;
+
+
+@Route(value = "cars/porsche", layout = MainView.class)
+public class PorscheView extends AbstractCarView
+{
+	@Override
+	@SuppressWarnings("checkstyle:MagicNumber")
+	protected List<Car> getCars()
+	{
+		return getCarsByBrand(PORSCHE);
+	}
+}
diff --git a/vaadin-breadcrumbs-demo/src/main/resources/vaadin-i18n/translations_de.properties b/vaadin-breadcrumbs-demo/src/main/resources/vaadin-i18n/translations_de.properties
@@ -0,0 +1,12 @@
+breadcrumb_home=Startseite
+breadcrumb_cars=Autos
+breadcrumb_porsche=Porsche
+breadcrumb_audi=Audi
+breadcrumb_bmw=BMW
+
+sidenav_cars=Autos
+sidenav_home=Startseite
+
+grid_branch=Marke
+grid_type=Modell
+grid_hp=PS
diff --git a/vaadin-breadcrumbs-demo/src/main/resources/vaadin-i18n/translations_en.properties b/vaadin-breadcrumbs-demo/src/main/resources/vaadin-i18n/translations_en.properties
@@ -0,0 +1,12 @@
+breadcrumb_home=Home
+breadcrumb_cars=Cars
+breadcrumb_porsche=Porsche
+breadcrumb_audi=Audi
+breadcrumb_bmw=BMW
+
+sidenav_cars=Cars
+sidenav_home=Home
+
+grid_branch=Branch
+grid_type=Type
+grid_hp=HP
diff --git a/vaadin-breadcrumbs/src/main/java/software/xdev/vaadin/breadcrumbs/Breadcrumbs.java b/vaadin-breadcrumbs/src/main/java/software/xdev/vaadin/breadcrumbs/Breadcrumbs.java
@@ -0,0 +1,121 @@
+/*
+ * Copyright © 2024 XDEV Software (https://xdev.software)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package software.xdev.vaadin.breadcrumbs;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import com.vaadin.flow.component.UI;
+import com.vaadin.flow.component.dependency.CssImport;
+import com.vaadin.flow.component.html.Anchor;
+import com.vaadin.flow.component.orderedlayout.HorizontalLayout;
+
+
+/**
+ * The Breadcrumbs class is a custom component for creating a breadcrumb navigation bar within a Vaadin application.
+ * <p>
+ * It extends the HorizontalLayout class to arrange breadcrumb links horizontally.
+ * </p>
+ */
+@CssImport("./styles/breadcrumb.css")
+public class Breadcrumbs extends HorizontalLayout
+{
+	private static final String DELIMITER_URL = "/";
+	private static final String I18N_PREFIX = "breadcrumb_";
+	private static final String BREADCRUMB_CSS = "breadcrumb";
+	private static final String BREADCRUMBS_CONTAINER_CSS = "breadcrumbs-container";
+	private static final String BREADCRUMB_DISABLED_CSS = "breadcrumb-disabled";
+	
+	public Breadcrumbs(final String path)
+	{
+		this();
+		this.updatePath(path);
+	}
+	
+	public Breadcrumbs()
+	{
+		this.addClassName(BREADCRUMBS_CONTAINER_CSS);
+	}
+	
+	/**
+	 * Initializes the breadcrumb navigation based on the given URL path. It splits the path, creates breadcrumb items
+	 * for each part, and updates the view.
+	 *
+	 * @param path the navigation path to be represented by the breadcrumbs.
+	 */
+	public void updatePath(final String path)
+	{
+		final List<Breadcrumb> breadcrumbs = new ArrayList<>();
+		breadcrumbs.add(new Breadcrumb(this.getTranslation(I18N_PREFIX + "home"), DELIMITER_URL));
+		
+		final List<String> partsList = new ArrayList<>(Arrays.asList(path.split(DELIMITER_URL)));
+		
+		final StringBuilder hrefBuilder = new StringBuilder();
+		for(final String part : partsList)
+		{
+			if(!part.isEmpty())
+			{
+				// append to full link
+				hrefBuilder.append(DELIMITER_URL).append(part);
+				final String title = this.getTranslation(I18N_PREFIX + part.toLowerCase());
+				
+				breadcrumbs.add(new Breadcrumb(title, hrefBuilder.toString()));
+			}
+		}
+		
+		this.updateView(breadcrumbs);
+	}
+	
+	/**
+	 * Updates the view with the given list of breadcrumbs. It removes all existing components and adds new anchors for
+	 * each breadcrumb.
+	 *
+	 * @param breadcrumbs the list of breadcrumbs to be displayed.
+	 */
+	protected void updateView(final List<Breadcrumb> breadcrumbs)
+	{
+		this.removeAll();
+		
+		final HorizontalLayout layout = new HorizontalLayout();
+		layout.setSpacing(false);
+		for(final Breadcrumb breadcrumb : breadcrumbs)
+		{
+			final Anchor anchor = new Anchor(breadcrumb.url(), breadcrumb.label());
+			anchor.addClassName(BREADCRUMB_CSS);
+			
+			// remove link and set css if url is empty (e.g. for 'edit' pages)
+			if(breadcrumb.url.isEmpty())
+			{
+				anchor.removeHref();
+				anchor.addClassName(BREADCRUMB_DISABLED_CSS);
+			}
+			
+			layout.add(anchor);
+		}
+		this.add(layout);
+	}
+	
+	public void updateFromCurrentPath()
+	{
+		this.updatePath(UI.getCurrent().getActiveViewLocation().getPath());
+	}
+	
+	protected record Breadcrumb(String label, String url)
+	{
+	}
+}
+
diff --git a/vaadin-breadcrumbs/src/main/resources/META-INF/resources/frontend/styles/breadcrumb.css b/vaadin-breadcrumbs/src/main/resources/META-INF/resources/frontend/styles/breadcrumb.css

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +package software.xdev.vaadin.view.cars;
++
 +public record Car(String brand, String name, int hp)
 +{
 +}